 |
Leptonica 1.68
C Image Processing Library
|
|
Leptonica 1.68
C Image Processing Library
|
Impements an array of C strings, and useful utilities based on it. More...
Go to the source code of this file.
Impements an array of C strings, and useful utilities based on it.
Create/Destroy/Copy
SARRAY *sarrayCreate()
SARRAY *sarrayCreateInitialized()
SARRAY *sarrayCreateWordsFromString()
SARRAY *sarrayCreateLinesFromString()
void *sarrayDestroy()
SARRAY *sarrayCopy()
SARRAY *sarrayClone()
Add/Remove string
l_int32 sarrayAddString()
l_int32 sarrayExtendArray()
char *sarrayRemoveString()
l_int32 sarrayReplaceString()
l_int32 sarrayClear()
Accessors
l_int32 sarrayGetCount()
char **sarrayGetArray()
char *sarrayGetString()
l_int32 sarrayGetRefcount()
l_int32 sarrayChangeRefcount()
Conversion back to string
char *sarrayToString()
char *sarrayToStringRange()
Concatenate 2 sarrays
l_int32 sarrayConcatenate()
l_int32 sarrayAppendRange()
Pad an sarray to be the same size as another sarray
l_int32 sarrayPadToSameSize()
Convert word sarray to (formatted) line sarray
SARRAY *sarrayConvertWordsToLines()
Split string on separator list
SARRAY *sarraySplitString()
Filter sarray
SARRAY *sarraySelectBySubstring()
SARRAY *sarraySelectByRange()
l_int32 sarrayParseRange()
Sort
SARRAY *sarraySort()
l_int32 stringCompareLexical()
Serialize for I/O
SARRAY *sarrayRead()
SARRAY *sarrayReadStream()
l_int32 sarrayWrite()
l_int32 sarrayWriteStream()
l_int32 sarrayAppend()
Directory filenames
SARRAY *getNumberedPathnamesInDirectory()
SARRAY *getSortedPathnamesInDirectory()
SARRAY *getFilenamesInDirectory()
Comments on usage:
These functions are important for efficient manipulation
of string data. They have been used in leptonica for
generating and parsing text files, and for generating
code for compilation. The user is responsible for
correctly disposing of strings that have been extracted
from sarrays.
- When you want a string from an Sarray to inspect it, or
plan to make a copy of it later, use sarrayGetString()
with copyflag = 0. In this case, you must neither free
the string nor put it directly in another array.
We provide the copyflag constant L_NOCOPY, which is 0,
for this purpose:
str-not-owned = sarrayGetString(sa, index, L_NOCOPY);
To extract a copy of a string, use:
str-owned = sarrayGetString(sa, index, L_COPY);
- When you want to insert a string that is in one
array into another array (always leaving the first
array intact), you have two options:
(1) use copyflag = L_COPY to make an immediate copy,
which you must then add to the second array
by insertion; namely,
str-owned = sarrayGetString(sa, index, L_COPY);
sarrayAddString(sa, str-owned, L_INSERT);
(2) use copyflag = L_NOCOPY to get another handle to
the string, in which case you must add
a copy of it to the second string array:
str-not-owned = sarrayGetString(sa, index, L_NOCOPY);
sarrayAddString(sa, str-not-owned, L_COPY).
In all cases, when you use copyflag = L_COPY to extract
a string from an array, you must either free it
or insert it in an array that will be freed later.
Definition in file sarray.c.
Input: size of string ptr array to be alloc'd (use 0 for default) Return: sarray, or null on error
Definition at line 140 of file sarray.c.
References Sarray::array, CALLOC, ERROR_PTR, INITIAL_PTR_ARRAYSIZE, Sarray::n, Sarray::nalloc, NULL, PROCNAME, and Sarray::refcount.
Referenced by bmfGetLineStrings(), captureProtoSignature(), ccbaWriteSVGString(), cleanProtoSignature(), fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), fmorphautogen2(), generateContentStringPdf(), generateFixedStringsPdf(), generateFlatePS(), generateG4PS(), generateJpegPS(), generatePagesObjStringPdf(), generatePageStringPdf(), generateUncompressedPS(), getFilenamesInDirectory(), getNumberedPathnamesInDirectory(), getSortedPathnamesInDirectory(), gplotAddPlot(), gplotCreate(), main(), makeTrailerStringPdf(), parseForProtos(), pathJoin(), pdfdataCreate(), pixColorMorphSequence(), pixGrayMorphSequence(), pixHtmlViewer(), pixMorphCompSequence(), pixMorphCompSequenceDwa(), pixMorphSequence(), pixMorphSequenceDwa(), pixReadBarcodes(), sarrayConvertWordsToLines(), sarrayCopy(), sarrayCreateInitialized(), sarrayCreateLinesFromString(), sarrayCreateWordsFromString(), sarrayMakeInnerLoopDWACode(), sarrayMakeWplsCode(), sarrayReadStream(), sarraySelectByRange(), sarraySelectBySubstring(), selaGetSelnames(), splitStringToParagraphs(), and sudokuReadFile().
Input: n (size of string ptr array to be alloc'd) initstr (string to be initialized on the full array) Return: sarray, or null on error
Definition at line 169 of file sarray.c.
References ERROR_PTR, L_COPY, NULL, PROCNAME, sarrayAddString(), and sarrayCreate().
Referenced by getNumberedPathnamesInDirectory().
| SARRAY* sarrayCreateWordsFromString | ( | const char * | string | ) |
Input: string Return: sarray, or null on error
Notes: (1) This finds the number of word substrings, creates an sarray of this size, and puts copies of each substring into the sarray.
Definition at line 200 of file sarray.c.
References ERROR_PTR, FALSE, NULL, PROCNAME, sarrayCreate(), sarraySplitString(), size, and TRUE.
Referenced by bmfGetLineStrings(), cleanProtoSignature(), main(), parseForProtos(), and sudokuReadFile().
Input: string blankflag (0 to exclude blank lines; 1 to include) Return: sarray, or null on error
Notes: (1) This finds the number of line substrings, each of which ends with a newline, and puts a copy of each substring in a new sarray. (2) The newline characters are removed from each substring.
Definition at line 249 of file sarray.c.
References ERROR_PTR, FREE, L_INSERT, NULL, PROCNAME, sarrayAddString(), sarrayCreate(), sarraySplitString(), size, and stringNew().
Referenced by fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), fmorphautogen2(), jbDataRead(), kernelCreateFromFile(), main(), parseForProtos(), parseTrailerPdf(), selaCreateFromFile(), splitStringToParagraphs(), and sudokuReadFile().
| void sarrayDestroy | ( | SARRAY ** | psa | ) |
Input: &sarray <to be="" nulled>=""> Return: void
Notes: (1) Decrements the ref count and, if 0, destroys the sarray. (2) Always nulls the input ptr.
Definition at line 319 of file sarray.c.
References Sarray::array, FREE, L_WARNING, Sarray::n, NULL, PROCNAME, sarrayChangeRefcount(), and sarrayGetRefcount().
Referenced by bmfGetLineStrings(), captureProtoSignature(), ccbaWriteSVGString(), cleanProtoSignature(), concatenatePdf(), concatenatePdfToData(), convertFilesFittedToPS(), convertFilesTo1bpp(), convertFilesToPdf(), convertFilesToPS(), convertSegmentedFilesToPdf(), convertSegmentedPagesToPS(), fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), fmorphautogen2(), generateContentStringPdf(), generateFixedStringsPdf(), generateFlatePS(), generateG4PS(), generateJpegPS(), generatePagesObjStringPdf(), generatePageStringPdf(), generateUncompressedPS(), getNumberedPathnamesInDirectory(), getSortedPathnamesInDirectory(), gplotAddPlot(), gplotDestroy(), gplotRead(), jbClasserDestroy(), jbCorrelation(), jbDataRead(), jbRankHaus(), jbWordsInTextlines(), kernelCreateFromFile(), lept_rmdir(), main(), makeTrailerStringPdf(), parseForProtos(), parseTrailerPdf(), pathJoin(), pdfdataDestroy(), pixacompCreateFromFiles(), pixAddSingleTextblock(), pixaReadFiles(), pixColorMorphSequence(), pixGrayMorphSequence(), pixHtmlViewer(), pixMorphCompSequence(), pixMorphCompSequenceDwa(), pixMorphSequence(), pixMorphSequenceDwa(), pixReadBarcodes(), pixSetTextblock(), regTestCompareFiles(), sarrayConvertWordsToLines(), selaCreateFromFile(), splitStringToParagraphs(), sudokuReadFile(), and writeMultipageTiff().
Input: sarray Return: copy of sarray, or null on error
Definition at line 357 of file sarray.c.
References Sarray::array, ERROR_PTR, L_COPY, Sarray::n, Sarray::nalloc, NULL, PROCNAME, sarrayAddString(), and sarrayCreate().
Referenced by jbAddPages(), jbWordsInTextlines(), sarraySelectBySubstring(), and sarraySort().
Input: sarray string (string to be added) copyflag (L_INSERT, L_COPY) Return: 0 if OK, 1 on error
Notes: (1) Legacy usage decrees that we always use 0 to insert a string directly and 1 to insert a copy of the string. The enums for L_INSERT and L_COPY agree with this convention, and will not change in the future. (2) See usage comments at the top of this file.
Definition at line 411 of file sarray.c.
References Sarray::array, ERROR_INT, L_COPY, L_INSERT, Sarray::n, Sarray::nalloc, PROCNAME, sarrayExtendArray(), sarrayGetCount(), and stringNew().
Referenced by bmfGetLineStrings(), captureProtoSignature(), ccbaWriteSVGString(), cleanProtoSignature(), fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), fmorphautogen2(), generateColormapStringsPdf(), generateContentStringPdf(), generateFixedStringsPdf(), generateFlatePS(), generateG4PS(), generateJpegPS(), generatePagesObjStringPdf(), generatePageStringPdf(), generatePreXStringsPdf(), generateUncompressedPS(), getFilenamesInDirectory(), getSortedPathnamesInDirectory(), gplotAddPlot(), gplotGenCommandFile(), main(), makeTrailerStringPdf(), parseForProtos(), pixHtmlViewer(), pixReadBarcodes(), sarrayAppendRange(), sarrayConcatenate(), sarrayConvertWordsToLines(), sarrayCopy(), sarrayCreateInitialized(), sarrayCreateLinesFromString(), sarrayMakeInnerLoopDWACode(), sarrayMakeWplsCode(), sarrayPadToSameSize(), sarrayReadStream(), sarraySelectByRange(), sarraySelectBySubstring(), sarraySplitString(), selaGetSelnames(), splitStringToParagraphs(), and sudokuReadFile().
Input: sarray Return: 0 if OK, 1 on error
Definition at line 447 of file sarray.c.
References Sarray::array, ERROR_INT, Sarray::nalloc, NULL, PROCNAME, and reallocNew().
Referenced by sarrayAddString().
Input: sarray index (of string within sarray) Return: removed string, or null on error
Definition at line 472 of file sarray.c.
References ERROR_PTR, L_RegParams::index, Sarray::n, NULL, PROCNAME, and sarrayGetArray().
Input: sarray index (of string within sarray to be replaced) newstr (string to replace existing one) copyflag (L_INSERT, L_COPY) Return: 0 if OK, 1 on error
Notes: (1) This destroys an existing string and replaces it with the new string or a copy of it. (2) By design, an sarray is always compacted, so there are never any holes (null ptrs) in the ptr array up to the current count.
Definition at line 521 of file sarray.c.
References Sarray::array, ERROR_INT, FREE, L_RegParams::index, L_COPY, L_INSERT, PROCNAME, sarrayGetCount(), and stringNew().
Referenced by getNumberedPathnamesInDirectory().
Input: sarray Return: 0 if OK; 1 on error
Definition at line 558 of file sarray.c.
References Sarray::array, ERROR_INT, FREE, Sarray::n, NULL, and PROCNAME.
Referenced by gplotGenCommandFile().
Input: sarray Return: count, or 0 if no strings or on error
Definition at line 585 of file sarray.c.
References ERROR_INT, Sarray::n, and PROCNAME.
Referenced by bmfGetLineStrings(), bmfGetWordWidths(), cleanProtoSignature(), convertFilesTo1bpp(), convertSegmentedFilesToPdf(), convertSegmentedPagesToPS(), getNextNonBlankLine(), getNextNonCommentLine(), getNextNonDoubleSlashLine(), getNumberedPathnamesInDirectory(), getOffsetForCharacter(), getOffsetForMatchingRP(), getSortedPathnamesInDirectory(), gplotGenCommandFile(), gplotGenDataFiles(), jbAddPages(), jbCorrelation(), jbDataRead(), jbRankHaus(), jbWordsInTextlines(), kernelCreateFromFile(), lept_rmdir(), main(), morphSequenceVerify(), pathJoin(), pixacompCreateFromSA(), pixAddSingleTextblock(), pixaReadFilesSA(), pixColorMorphSequence(), pixGrayMorphSequence(), pixHtmlViewer(), pixMorphCompSequence(), pixMorphCompSequenceDwa(), pixMorphSequence(), pixMorphSequenceDwa(), pixReadBarcodes(), pixReadIndexed(), pixSetTextblock(), regTestCompareFiles(), saConcatenatePdfToData(), saConvertFilesToPdfData(), sarrayAddString(), sarrayAppendRange(), sarrayConcatenate(), sarrayConvertFilesFittedToPS(), sarrayConvertFilesToPS(), sarrayConvertWordsToLines(), sarrayPadToSameSize(), sarrayParseRange(), sarrayReplaceString(), sarraySelectByRange(), sarraySelectBySubstring(), sarraySort(), sarrayToStringRange(), sarrayWriteStream(), selaCreateFromFile(), selCreateFromSArray(), skipToMatchingBrace(), skipToSemicolon(), splitStringToParagraphs(), sudokuReadFile(), writeCustomTiffTags(), and writeMultipageTiffSA().
Input: sarray &nalloc (<optional return>=""> number allocated string ptrs) &n (<optional return>=""> number allocated strings) Return: ptr to string array, or null on error
Notes: (1) Caution: the returned array is not a copy, so caller must not destroy it!
Definition at line 608 of file sarray.c.
References Sarray::array, ERROR_PTR, Sarray::n, Sarray::nalloc, NULL, and PROCNAME.
Referenced by sarrayRemoveString().
Input: sarray index (to the index-th string) copyflag (L_NOCOPY or L_COPY) Return: string, or null on error
Notes: (1) Legacy usage decrees that we always use 0 to get the pointer to the string itself, and 1 to get a copy of the string. (2) See usage comments at the top of this file. (3) To get a pointer to the string itself, use for copyflag: L_NOCOPY or 0 or FALSE To get a copy of the string, use for copyflag: L_COPY or 1 or TRUE The const values of L_NOCOPY and L_COPY are guaranteed not to change.
Definition at line 648 of file sarray.c.
References Sarray::array, ERROR_PTR, L_RegParams::index, L_COPY, L_NOCOPY, Sarray::n, NULL, PROCNAME, and stringNew().
Referenced by bmfGetWordWidths(), captureProtoSignature(), cleanProtoSignature(), convertFilesTo1bpp(), convertSegmentedFilesToPdf(), fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), fmorphautogen2(), generateOutputDataPdf(), getNextNonBlankLine(), getNextNonCommentLine(), getNextNonDoubleSlashLine(), getNumberedPathnamesInDirectory(), getOffsetForCharacter(), getOffsetForMatchingRP(), getSortedPathnamesInDirectory(), gplotGenCommandFile(), gplotGenDataFiles(), jbAddPages(), jbDataRead(), jbWordsInTextlines(), kernelCreateFromFile(), lept_rmdir(), main(), morphSequenceVerify(), parseForProtos(), parseTrailerPdf(), pathJoin(), pixacompCreateFromSA(), pixAddSingleTextblock(), pixaReadFilesSA(), pixColorMorphSequence(), pixGrayMorphSequence(), pixHtmlViewer(), pixMorphCompSequence(), pixMorphCompSequenceDwa(), pixMorphSequence(), pixMorphSequenceDwa(), pixReadIndexed(), pixSetTextblock(), ptraConcatenatePdfToData(), regTestCompareFiles(), saConcatenatePdfToData(), saConvertFilesToPdfData(), sarrayAppendRange(), sarrayConcatenate(), sarrayConvertFilesFittedToPS(), sarrayConvertFilesToPS(), sarrayConvertWordsToLines(), sarrayParseRange(), sarraySelectByRange(), sarraySelectBySubstring(), sarrayToStringRange(), selaCreateFromFile(), selCreateFromSArray(), skipToMatchingBrace(), skipToSemicolon(), splitStringToParagraphs(), sudokuReadFile(), writeCustomTiffTags(), and writeMultipageTiffSA().
sarrayGetRefCount()
Input: sarray Return: refcount, or UNDEF on error
Definition at line 675 of file sarray.c.
References ERROR_INT, PROCNAME, Sarray::refcount, and UNDEF.
Referenced by sarrayDestroy().
sarrayChangeRefCount()
Input: sarray delta (change to be applied) Return: 0 if OK, 1 on error
Definition at line 693 of file sarray.c.
References ERROR_INT, PROCNAME, Sarray::refcount, and UNDEF.
Referenced by sarrayClone(), and sarrayDestroy().
Input: sarray addnlflag (flag: 0 adds nothing to each substring 1 adds '
' to each substring 2 adds ' ' to each substring) Return: dest string, or null on error
Notes: (1) Concatenates all the strings in the sarray, preserving all white space. (2) If addnlflag != 0, adds either a '
' or a ' ' after each substring. (3) This function was NOT implemented as: for (i = 0; i < n; i++) strcat(dest, sarrayGetString(sa, i, L_NOCOPY)); Do you see why?
Definition at line 728 of file sarray.c.
References ERROR_PTR, NULL, PROCNAME, and sarrayToStringRange().
Referenced by captureProtoSignature(), ccbaWriteSVGString(), cleanProtoSignature(), fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), fmorphautogen2(), generateContentStringPdf(), generateFixedStringsPdf(), generateFlatePS(), generateG4PS(), generateJpegPS(), generatePagesObjStringPdf(), generatePageStringPdf(), generateUncompressedPS(), gplotAddPlot(), gplotGenCommandFile(), main(), makeTrailerStringPdf(), parseForProtos(), pixHtmlViewer(), sarrayConvertWordsToLines(), and splitStringToParagraphs().
Input: sarray first (index of first string to use; starts with 0) nstrings (number of strings to append into the result; use 0 to append to the end of the sarray) addnlflag (flag: 0 adds nothing to each substring 1 adds '
' to each substring 2 adds ' ' to each substring) Return: dest string, or null on error
Notes: (1) Concatenates the specified strings inthe sarray, preserving all white space. (2) If addnlflag != 0, adds either a '
' or a ' ' after each substring. (3) If the sarray is empty, this returns a string with just the character corresponding to .
Definition at line 761 of file sarray.c.
References CALLOC, ERROR_PTR, L_RegParams::index, L_NOCOPY, NULL, PROCNAME, sarrayGetCount(), sarrayGetString(), size, and stringNew().
Referenced by bmfGetLineStrings(), and sarrayToString().
Input: sa1 (to be added to) sa2 (append to sa1) Return: 0 if OK, 1 on error
Notes: (1) Copies of the strings in sarray2 are added to sarray1.
Definition at line 842 of file sarray.c.
References ERROR_INT, L_COPY, L_NOCOPY, PROCNAME, sarrayAddString(), sarrayGetCount(), and sarrayGetString().
Referenced by fhmtautogen2(), fmorphautogen2(), and main().
Input: sa1 (to be added to) sa2 (append specified range of strings in sa2 to sa1) start (index of first string of sa2 to append) end (index of last string of sa2 to append) Return: 0 if OK, 1 on error
Notes: (1) Copies of the strings in sarray2 are added to sarray1. (2) The [start ... end] range is truncated if necessary.
Definition at line 879 of file sarray.c.
References ERROR_INT, L_COPY, L_NOCOPY, PROCNAME, sarrayAddString(), sarrayGetCount(), and sarrayGetString().
Referenced by fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), and fmorphautogen2().
Input: sa1, sa2 padstring Return: 0 if OK, 1 on error
Notes: (1) If two sarrays have different size, this adds enough instances of to the smaller so that they are the same size. It is useful when two or more sarrays are being sequenced in parallel, and it is necessary to find a valid string at each index.
Definition at line 928 of file sarray.c.
References ERROR_INT, L_COPY, PROCNAME, sarrayAddString(), and sarrayGetCount().
Referenced by convertSegmentedPagesToPS().
Input: sa (sa of individual words) linesize (max num of chars in each line) Return: saout (sa of formatted lines), or null on error
This is useful for re-typesetting text to a specific maximum line length. The individual words in the input sarray are concatenated into textlines. An input word string of zero length is taken to be a paragraph separator. Each time such a string is found, the current line is ended and a new line is also produced that contains just the string of zero length (""). When the output sarray of lines is eventually converted to a string with newlines (typically) appended to each line string, the empty strings are just converted to newlines, producing the visible paragraph separation.
What happens when a word is larger than linesize? We write it out as a single line anyway! Words preceding or following this long word are placed on lines preceding or following the line with the long word. Why this choice? Long "words" found in text documents are typically URLs, and it's often desirable not to put newlines in the middle of a URL. The text display program (e.g., text editor) will typically wrap the long "word" to fit in the window.
Definition at line 986 of file sarray.c.
References ERROR_PTR, L_COPY, L_INSERT, L_NOCOPY, NULL, PROCNAME, sarrayAddString(), sarrayCreate(), sarrayDestroy(), sarrayGetCount(), sarrayGetString(), and sarrayToString().
Definition at line 1064 of file sarray.c.
References ERROR_INT, FREE, L_INSERT, NULL, PROCNAME, sarrayAddString(), stringNew(), and strtokSafe().
Referenced by pathJoin(), pixColorMorphSequence(), pixGrayMorphSequence(), pixMorphCompSequence(), pixMorphCompSequenceDwa(), pixMorphSequence(), pixMorphSequenceDwa(), sarrayCreateLinesFromString(), and sarrayCreateWordsFromString().
Input: sain (input sarray) substr (<optional> substring for matching; can be NULL) Return: saout (output sarray, filtered with substring) or null on error
Notes: (1) This selects all strings in sain that have substr as a substring. Note that we can't use strncmp() because we're looking for a match to the substring anywhere within each filename. (2) If substr == NULL, returns a copy of the sarray.
Definition at line 1108 of file sarray.c.
References arrayFindSequence(), ERROR_PTR, L_COPY, L_NOCOPY, NULL, PROCNAME, sarrayAddString(), sarrayCopy(), sarrayCreate(), sarrayGetCount(), and sarrayGetString().
Referenced by getSortedPathnamesInDirectory().
Input: sain (input sarray) first (index of first string to be selected) last (index of last string to be selected; use 0 to go to the end of the sarray) Return: saout (output sarray), or null on error
Notes: (1) This makes consisting of copies of all strings in in the index set [first ... last]. Use == 0 to get all strings from to the last string in the sarray.
Definition at line 1152 of file sarray.c.
References ERROR_PTR, L_COPY, L_INSERT, L_WARNING, NULL, PROCNAME, sarrayAddString(), sarrayCreate(), sarrayGetCount(), and sarrayGetString().
Referenced by main().
| l_int32 sarrayParseRange | ( | SARRAY * | sa, |
| l_int32 | start, | ||
| l_int32 * | pactualstart, | ||
| l_int32 * | pend, | ||
| l_int32 * | pnewstart, | ||
| const char * | substr, | ||
| l_int32 | loc | ||
| ) |
Input: sa (input sarray) start (index to start range search) &actualstart (<return> index of actual start; may be > 'start') &end (<return> index of end) &newstart (<return> index of start of next range) substr (substring for matching at beginning of string) loc (byte offset within the string for the pattern; use -1 if the location does not matter); Return: 0 if valid range found; 1 otherwise
Notes: (1) This finds the range of the next set of strings in SA, beginning the search at 'start', that does NOT have the substring 'substr' either at the indicated location in the string or anywhere in the string. The input variable 'loc' is the specified offset within the string; use -1 to indicate 'anywhere in the string'. (2) Always check the return value to verify that a valid range was found. (3) If a valid range is not found, the values of actstart, end and newstart are all set to the size of sa. (4) If this is the last valid range, newstart returns the value n. In use, this should be tested before calling the function. (5) Usage example. To find all the valid ranges in a file where the invalid lines begin with two dashes, copy each line in the file to a string in an sarray, and do: start = 0; while (!sarrayParseRange(sa, start, &actstart, &end, &start, "--", 0)) fprintf(stderr, "start = %d, end = %d\n", actstart, end);
Definition at line 1219 of file sarray.c.
References arrayFindSequence(), ERROR_INT, L_NOCOPY, PROCNAME, sarrayGetCount(), and sarrayGetString().
Referenced by fhmtautogen1(), fhmtautogen2(), fmorphautogen1(), and fmorphautogen2().
Input: saout (output sarray; can be NULL or equal to sain) sain (input sarray) sortorder (L_SORT_INCREASING or L_SORT_DECREASING) Return: saout (output sarray, sorted by ascii value), or null on error
Notes: (1) Set saout = sain for in-place; otherwise, set naout = NULL. (2) Shell sort, modified from K&R, 2nd edition, p.62. Slow but simple O(n logn) sort.
Definition at line 1311 of file sarray.c.
References Sarray::array, ERROR_PTR, L_SORT_DECREASING, L_SORT_INCREASING, NULL, PROCNAME, sarrayCopy(), sarrayGetCount(), and stringCompareLexical().
Referenced by getSortedPathnamesInDirectory(), and main().
| l_int32 stringCompareLexical | ( | const char * | str1, |
| const char * | str2 | ||
| ) |
Input: str1 str2 Return: 1 if str1 > str2 (lexically); 0 otherwise
Notes: (1) If the lexical values are identical, return a 0, to indicate that no swapping is required to sort the strings.
Definition at line 1365 of file sarray.c.
References ERROR_INT, L_MIN, and PROCNAME.
Referenced by sarraySort().
| SARRAY* sarrayRead | ( | const char * | filename | ) |
Input: filename Return: sarray, or null on error
Definition at line 1407 of file sarray.c.
References ERROR_PTR, fopenReadStream(), L_RegParams::fp, NULL, PROCNAME, and sarrayReadStream().
Referenced by main().
| SARRAY* sarrayReadStream | ( | FILE * | fp | ) |
Input: stream Return: sarray, or null on error
Notes: (1) We store the size of each string along with the string. (2) This allows a string to have embedded newlines. By reading the entire string, as determined by its size, we are not affected by any number of embedded newlines.
Definition at line 1443 of file sarray.c.
References CALLOC, ERROR_PTR, FREE, L_RegParams::index, L_BUF_SIZE, L_COPY, NULL, PROCNAME, SARRAY_VERSION_NUMBER, sarrayAddString(), sarrayCreate(), size, and version.
Referenced by gplotRead(), and sarrayRead().
Input: filename sarray Return: 0 if OK; 1 on error
Definition at line 1500 of file sarray.c.
References ERROR_INT, fopenWriteStream(), L_RegParams::fp, NULL, PROCNAME, and sarrayWriteStream().
Referenced by main().
Input: stream sarray Returns 0 if OK; 1 on error
Notes: (1) This appends a '
' to each string, which is stripped off by sarrayReadStream().
Definition at line 1535 of file sarray.c.
References Sarray::array, ERROR_INT, PROCNAME, SARRAY_VERSION_NUMBER, and sarrayGetCount().
Referenced by gplotWrite(), main(), parseTrailerPdf(), sarrayAppend(), and sarrayWrite().
Input: filename sarray Return: 0 if OK; 1 on error
Definition at line 1568 of file sarray.c.
References ERROR_INT, fopenWriteStream(), L_RegParams::fp, NULL, PROCNAME, and sarrayWriteStream().
| SARRAY* getNumberedPathnamesInDirectory | ( | const char * | dirname, |
| const char * | substr, | ||
| l_int32 | numpre, | ||
| l_int32 | numpost, | ||
| l_int32 | maxnum | ||
| ) |
getNumberedPathnamesInDirectory()
Input: directory name substr (<optional> substring filter on filenames; can be NULL) numpre (number of characters in name before number) numpost (number of characters in name after number, up to a dot before an extension) including an extension and the dot separator) maxnum (only consider page numbers up to this value) Return: sarray of sorted pathnames, or NULL on error
Notes: (1) Returns the full pathnames of the numbered filenames in the directory. The number in the filename is the index into the sarray. For indices for which there are no filenames, an empty string ("") is placed into the sarray. This makes reading numbered files very simple. For example, the image whose filename includes number N can be retrieved using pixReadIndexed(sa, N); (2) If is not NULL, only filenames that contain the substring can be included. If is NULL, all matching filenames are used. (3) If no numbered files are found, it returns an empty sarray, with no initialized strings. (4) It is assumed that the page number is contained within the basename (the filename without directory or extension). is the number of characters in the basename preceeding the actual page number; is the number following the page number, up to either the end of the basename or a ".", whichever comes first. (5) To use a O(n) matching algorithm, the largest page number is found and two internal arrays of this size are created. This maximum is constrained not to exceed , to make sure that an unrealistically large number is not accidentally used to determine the array sizes.
Definition at line 1632 of file sarray.c.
References ERROR_PTR, extractNumberFromFilename(), getSortedPathnamesInDirectory(), L_RegParams::index, L_COPY, L_MIN, L_NOCOPY, L_WARNING_INT, nfiles, NULL, PROCNAME, sarrayCreate(), sarrayCreateInitialized(), sarrayDestroy(), sarrayGetCount(), sarrayGetString(), and sarrayReplaceString().
Referenced by convertSegmentedPagesToPS().
| SARRAY* getSortedPathnamesInDirectory | ( | const char * | dirname, |
| const char * | substr, | ||
| l_int32 | firstpage, | ||
| l_int32 | npages | ||
| ) |
getSortedPathnamesInDirectory()
Input: directory name substr (<optional> substring filter on filenames; can be NULL) firstpage (0-based) npages (use 0 for all to the end) Return: sarray of sorted pathnames, or NULL on error
Notes: (1) If is not NULL, only filenames that contain the substring can be returned. If == NULL, none of the filenames are filtered out. (2) The files in the directory, after optional filtering by the substring, are lexically sorted in increasing order. The full pathnames are returned for the requested sequence. If no files are found after filtering, returns an empty sarray.
Definition at line 1706 of file sarray.c.
References ERROR_PTR, genPathname(), getFilenamesInDirectory(), L_INSERT, L_MAX, L_MIN, L_NOCOPY, L_SORT_INCREASING, L_WARNING, nfiles, NULL, PROCNAME, sarrayAddString(), sarrayCreate(), sarrayDestroy(), sarrayGetCount(), sarrayGetString(), sarraySelectBySubstring(), and sarraySort().
Referenced by concatenatePdf(), concatenatePdfToData(), convertFilesFittedToPS(), convertFilesTo1bpp(), convertFilesToPdf(), convertFilesToPS(), convertSegmentedFilesToPdf(), getNumberedPathnamesInDirectory(), jbCorrelation(), jbRankHaus(), jbWordsInTextlines(), main(), pixacompCreateFromFiles(), pixaReadFiles(), regTestCompareFiles(), and writeMultipageTiff().
| SARRAY* getFilenamesInDirectory | ( | const char * | dirname | ) |
Input: directory name Return: sarray of file names, or NULL on error
Notes: (1) The versions compiled under unix and cygwin use the POSIX C library commands for handling directories. For windows, there is a separate implementation. (2) It returns an array of filename tails; i.e., only the part of the path after the last slash. (3) Use of the d_type field of dirent is not portable: "According to POSIX, the dirent structure contains a field char d_name[] of unspecified size, with at most NAME_MAX characters preceding the terminating null character. Use of other fields will harm the portability of your programs." (4) As a consequence of (3), we note several things:
Definition at line 1778 of file sarray.c.
References ERROR_PTR, L_COPY, NULL, PROCNAME, sarrayAddString(), and sarrayCreate().
Referenced by getSortedPathnamesInDirectory(), lept_rmdir(), main(), and pixHtmlViewer().
const l_int32 INITIAL_PTR_ARRAYSIZE = 50 [static] |
Definition at line 125 of file sarray.c.
Referenced by sarrayCreate().
const l_int32 L_BUF_SIZE = 512 [static] |
Definition at line 126 of file sarray.c.
Referenced by sarrayReadStream().
1.7.3