C# Class SIL.FieldWorks.TE.TeSfmImporter

This static method imports Scripture (This overload used only for testing w/o merge or overwrite dialog.)

Call this static method to Import Scripture

Determine whether the previous run is Verse Number.

Add any accumulated Back Translation(s) (one per WS) to the last paragraph created.

Add any pending chapter number and/or the current verse number as a run to each Back Translation.

Inserts the pending chapter number string into the beginning of a new paragraph, in proper location as a drop-cap.

Add an Import style proxy for the given mapping and include it in the hash map.

A second styleProxy is added if the mapping has an end marker.

Add the given text (using the text props from the current proxy) as a new run to the end of the current paragraph.

Add the given text and props as a new run to the end of the current paragraph.

Add the given text and props as a new run to the end of the specified paragraph under construction.

Begin a footnote: insert the footnote into the ScrBook and insert the footnote marker into the paragraph. Subsequent footnote segments will be added to the footnote paragraph until EndFootnote is called.

Check to see if the current footnote data is a USFM style footnote or otherwise begins with a single character that is likely to be a footnote marker. If so, strip the marker from the data. If we aren't sure, then we leave the data as is but let the caller know.

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the bug. If subclasses override this method, they should call the base implementation.

Finalize the BT of the footnote, if any.

When finished adding all segments of the current footnote, call this to reset builder and other state variables to resume normal segment processing and increment the footnote counter.

Clean-up any last paragraphs and such

If we have any pending text in buffers or Para builder, finish making the paragraph and add it to the database. Add it to the current title or section (make a section if we need one and don't have one). Clean up the string builder to prepare for a new paragraph.

Finalizes the title. If is empty, a single blank paragraph is written for whatever is missing.

Find a footnote with the specified style id

Find a footnote with the specified style id

Find the next picture

Find a paragraph containing the specified reference.

Find a paragraph with the specified style id, containing the specified verse number, if specified, and having the correct sequence number. Sets all appropriate state variables before returning.

Gets a paragraph builder for a simple, single-paragraph Scripture annotation discussion field. This is virtual to allow subclasses to return NULL if they can't deal with this much simplicity.

Get the verse part of the reference (as a string) from current Scripture segment

The string returned includes any sub-verse letters, etc. that would be hard to recreate from a numeric verse number (e.g., "2-6a")

This is the actual workhorse to Import Scripture

Initialize the scripture object wrapper.

Virtual for testing override purposes.

Initialize the scripture importer

Inserts a picture, either using the current segment (USFM-style) or the pending picture in m_currPictureInfo.

Load mapping proxies from m_settings.

Load the scripture project and enumerator, preparing us to read the data files.

Virtual for testing override purposes.

Process a back translation segment (duh)

Remember info about this paragraph so we can try to find a corresponding paragraph later.

Process this scripture text segment

Resets importer state variables for the new book Need to reset a few more things than the base class.

Throw an exception to end the import process.

Initializes a new instance of the TeSfmImporter class

Process any pending picture caption/copyright back translations.

Add a hard line break to separate this segment from the previous one. Then insert this segment as a new run. Use this version only for vernacular Scripture.

Add a hard line break to separate this segment from the previous one. Then insert this segment as a new run.

Add a new annotation to the pending list

Add a new annotation to the pending list

Add any pending annotations for the last paragraph.

Add footnote callers to the string builder being built for the Back Translation and add BT to the footnotes themselves.

Add any pending verse or chapter number as a run to the Back Translation for the given writing system.

Add a hard line break to separate this segment from the previous one. Then insert this segment as a new run.

Gets whether the chapter number is pending for the Back Translation for the given writing system.

Gets whether a verse number is pending for the Back Translation for the given writing system.

Checks for pending footnote text.

if we are in an intro paragraph (i.e. not in scripture content) then make sure the section head has an intro section head style

Creates a new CmTranslation to hold the BT in the given builder (and possibly BTs in other writing systems as well).

Ends the character style run.

Check the text representation of a picture for a folder. If it doesn't include the folder name, then add it.

Finalizes the current book.

Get the correct text props to use for the current BT segment. This method returns the properties of the current proxy, doped up with the given writing system if necessary.

Gets the rooted path.

Get the context and paragraph text properties for this segment.

Gets a style proxy for processing a segment

Return text props that can be used for a run of "Default Paragraph Characters" having only a WS.

Determine the writing system for the context. First use the WS of the para, if any (i.e., for BT paras); otherwise use the ws of the preceding segment, if any; otherwise use the default WS for the domain.

Choose the correct default WS based on the current import domain

Handle the start and end of book title segments

Handle footnote processing

Process a segment in the Note (Annotation) domain. This method doesn't actually create an annotation. It just adds info about it to an array, to be added later by AddPendingAnnotations.

If this segment is any other kind of paragraph besides the special cases already handled, then finish off the previous para and prepare for this new one.

Handle section head segments (begin or end)

If this segment is a special target then handle it

Handle the start of book segments

See if current segment is a verse number, and if so process the verse number part of it. Also prepare to handle any text following the number (vernacular stream only).

Initialize the m_fInterpretFootnoteSettings flag

We've processed paragraph start and inserted specially marked text segments. Insert other marked text, from the current segment, into our paragraph (or footnote).

Load mapping proxies from the given enumeration of mappings

Prepares a new Scripture section section (if needed). Used when the imported data switches from book title or background information to scripture data.

Handle a segment which may end a section head or book title. Prepare for a new paragraph by setting the m_ParaBldr.ParaStylePropsProxy and m_fInVerseTextParagraph members.

Process char style or footnote end marker in a back translation

Note: This logic is similar (and probably needs to be kept in synch with) ProcessEndMarker, but we can't use that method, because the details differ.

Process a book title. Note: they're always a new paragraph

Process char style or footnote end marker in the vernacular textF

Note: This logic is similar (and probably needs to be kept in synch with) ProcessBTEndMarker, but we can't use that method, because the details differ.

Handle a segment which initiates a new section.

Process segment which is the beginning of a new book.

Process segment which is the beginning of a new chapter

Process verse number segments

Remove control characters from the given string, and return the result. Tab characters are replaced by a space. Need to use this because control characters are not valid in XML unless they are quoted.

Throw an exception to report BT text that does not correspond to vernacular text

Set the Name property of the book if the current segment is the Main Title and the name has not already been set (i.e., by a Title Short segment).

Sets the state for a character style run. This can be a real character style or a special target (e.g., Footnote Target Ref) that is treated as a char style.

Sets the state for a footnote run.

Determine if this segment should be skipped as part of introductory material

Trims the last character from the given string builder if it's a separator