|
GME
13
|
Data substitution (keywords and EOL style) More...
Go to the source code of this file.
Data substitution (keywords and EOL style)
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ====================================================================
Definition in file svn_subst.h.
| #define SVN_SUBST_NATIVE_EOL_STR "\n" |
The EOL used in the Repository for "native" files
Definition at line 47 of file svn_subst.h.
| typedef enum svn_subst_eol_style svn_subst_eol_style_t |
Valid states for 'svn:eol-style' property.
Property nonexistence is equivalent to 'none'.
| typedef struct svn_subst_keywords_t svn_subst_keywords_t |
Values used in keyword expansion.
| enum svn_subst_eol_style |
Valid states for 'svn:eol-style' property.
Property nonexistence is equivalent to 'none'.
Definition at line 53 of file svn_subst.h.
| SVN_DEPRECATED svn_error_t* svn_subst_build_keywords | ( | svn_subst_keywords_t * | kw, |
| const char * | keywords_string, | ||
| const char * | rev, | ||
| const char * | url, | ||
| apr_time_t | date, | ||
| const char * | author, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_subst_build_keywords2() except that it populates an existing structure *kw instead of creating a keywords hash.
| SVN_DEPRECATED svn_error_t* svn_subst_build_keywords2 | ( | apr_hash_t ** | kw, |
| const char * | keywords_string, | ||
| const char * | rev, | ||
| const char * | url, | ||
| apr_time_t | date, | ||
| const char * | author, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_subst_build_keywords3() except that it does not accept the repos_root_url parameter and hence supports less substitutions, and also does not support custom keyword definitions.
| svn_error_t* svn_subst_build_keywords3 | ( | apr_hash_t ** | kw, |
| const char * | keywords_string, | ||
| const char * | rev, | ||
| const char * | url, | ||
| const char * | repos_root_url, | ||
| apr_time_t | date, | ||
| const char * | author, | ||
| apr_pool_t * | pool | ||
| ) |
Set *kw to a new keywords hash filled with the appropriate contents given a keywords_string (the contents of the svn:keywords property for the file in question), the revision rev, the url, the date the file was committed on, the author of the last commit, and the URL of the repository root repos_root_url.
Custom keywords defined in svn:keywords properties are expanded using the provided parameters and in accordance with the following format substitutions in the keywords_string: a - The author. b - The basename of the URL. d - Short format of the date. D - Long format of the date. P - The file's path, relative to the repository root URL. r - The revision. R - The URL to the root of the repository. u - The URL of the file. _ - A space (keyword definitions cannot contain a literal space). %% - A literal ''. H - Equivalent to P_r_d_a. I - Equivalent to b_r_d_a.
Custom keywords are defined by appending '=' to the keyword name, followed by a string containing any combination of the format substitutions.
Any of the inputs rev, url, date, author, and repos_root_url can be NULL, or 0 for date, to indicate that the information is not present. Each piece of information that is not present expands to the empty string wherever it appears in an expanded keyword value. (This can result in multiple adjacent spaces in the expansion of a multi-valued keyword such as "Id".)
Hash keys are of type const char *. Hash values are of type svn_string_t *.
All memory is allocated out of pool.
| SVN_DEPRECATED svn_error_t* svn_subst_copy_and_translate | ( | const char * | src, |
| const char * | dst, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| const svn_subst_keywords_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_subst_copy_and_translate2() except that special is always set to FALSE.
| SVN_DEPRECATED svn_error_t* svn_subst_copy_and_translate2 | ( | const char * | src, |
| const char * | dst, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| const svn_subst_keywords_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| svn_boolean_t | special, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_subst_copy_and_translate3() except that keywords is a svn_subst_keywords_t struct instead of a keywords hash.
| SVN_DEPRECATED svn_error_t* svn_subst_copy_and_translate3 | ( | const char * | src, |
| const char * | dst, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| svn_boolean_t | special, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_subst_copy_and_translate4() but without a cancellation function and baton.
| svn_error_t* svn_subst_copy_and_translate4 | ( | const char * | src, |
| const char * | dst, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| svn_boolean_t | special, | ||
| svn_cancel_func_t | cancel_func, | ||
| void * | cancel_baton, | ||
| apr_pool_t * | pool | ||
| ) |
Copy the contents of file-path src to file-path dst atomically, either creating dst or overwriting dst if it exists, possibly performing line ending and keyword translations.
The parameters *eol_str, repair, *keywords and expand are defined the same as in svn_subst_translate_stream3().
In addition, it will create a special file from normal form or translate one to normal form if special is TRUE.
If anything goes wrong during the copy, attempt to delete dst (if it exists).
If eol_str and keywords are NULL, behavior is just a byte-for-byte copy.
cancel_func and cancel_baton will be called (if not NULL) periodically to check for cancellation.
| svn_error_t* svn_subst_create_specialfile | ( | svn_stream_t ** | stream, |
| const char * | path, | ||
| apr_pool_t * | result_pool, | ||
| apr_pool_t * | scratch_pool | ||
| ) |
Set *stream to a writable stream that accepts content in the "normal form" for a special file, to be located at path, and will create that file when the stream is closed. The stream will be allocated in result_pool, and any temporary allocations will be made in scratch_pool.
If the platform does not support the semantics of the special file, write a regular file containing the "normal form" text. This enables special files to be written and read on platforms that do not treat them as special.
Note: the target file is created in a temporary location, then renamed into position, so the creation can be considered "atomic".
| svn_error_t* svn_subst_detranslate_string | ( | svn_string_t ** | new_value, |
| const svn_string_t * | value, | ||
| svn_boolean_t | for_output, | ||
| apr_pool_t * | pool | ||
| ) |
Translate the string value from UTF8 and LF line-endings into native character encoding and native line-endings. If for_output is TRUE, translate to the character encoding of the output locale, else to that of the default locale.
Set *new_value to the translated string, allocated in pool.
| void svn_subst_eol_style_from_value | ( | svn_subst_eol_style_t * | style, |
| const char ** | eol, | ||
| const char * | value | ||
| ) |
Set *style to the appropriate svn_subst_eol_style_t and *eol to the appropriate cstring for a given svn:eol-style property value.
Set *eol to
NULL for svn_subst_eol_style_none, orsvn_subst_eol_style_native, orsvn_subst_eol_style_fixed.If *style is NULL, it is ignored.
| SVN_DEPRECATED svn_boolean_t svn_subst_keywords_differ | ( | const svn_subst_keywords_t * | a, |
| const svn_subst_keywords_t * | b, | ||
| svn_boolean_t | compare_values | ||
| ) |
Similar to svn_subst_keywords_differ2() except that it compares two svn_subst_keywords_t structs instead of keyword hashes.
| svn_boolean_t svn_subst_keywords_differ2 | ( | apr_hash_t * | a, |
| apr_hash_t * | b, | ||
| svn_boolean_t | compare_values, | ||
| apr_pool_t * | pool | ||
| ) |
Return TRUE if a and b do not hold the same keywords.
a and b are hashes of the form produced by svn_subst_build_keywords2().
If compare_values is TRUE, "same" means that the a and b contain exactly the same set of keywords, and the values of corresponding keywords match as well. Else if compare_values is FALSE, then "same" merely means that a and b hold the same set of keywords, although those keywords' values might differ.
a and/or b may be NULL; for purposes of comparison, NULL is equivalent to holding no keywords.
| svn_error_t* svn_subst_read_specialfile | ( | svn_stream_t ** | stream, |
| const char * | path, | ||
| apr_pool_t * | result_pool, | ||
| apr_pool_t * | scratch_pool | ||
| ) |
Set *stream to a readable stream containing the "normal form" of the special file located at path. The stream will be allocated in result_pool, and any temporary allocations will be made in scratch_pool.
If the file at path is in fact a regular file, just read its content, which should be in the "normal form" for a special file. This enables special files to be written and read on platforms that do not treat them as special.
| SVN_DEPRECATED svn_error_t* svn_subst_stream_detranslated | ( | svn_stream_t ** | stream_p, |
| const char * | src, | ||
| svn_subst_eol_style_t | eol_style, | ||
| const char * | eol_str, | ||
| svn_boolean_t | always_repair_eols, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | special, | ||
| apr_pool_t * | pool | ||
| ) |
Set *stream_p to a stream that detranslates the file src from working copy form to normal form, allocated in pool.
The values specified for eol_style, *eol_str, keywords and special, should be the ones used to translate the file to its working copy form. Usually, these are the values specified by the user in the files' properties.
Inconsistent line endings in the file will be automatically repaired (made consistent) for some eol styles. For all others, an error is returned. By setting always_repair_eols to TRUE, eols will be made consistent even for those styles which don't have it by default.
| SVN_DEPRECATED svn_error_t* svn_subst_stream_from_specialfile | ( | svn_stream_t ** | stream, |
| const char * | path, | ||
| apr_pool_t * | pool | ||
| ) |
Set *stream to a stream which translates the special file at path to the internal representation for special files when read from. When written to, it does the reverse: creating a special file when the stream is closed.
| svn_stream_t* svn_subst_stream_translated | ( | svn_stream_t * | stream, |
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| apr_pool_t * | result_pool | ||
| ) |
Return a stream which performs eol translation and keyword expansion when read from or written to. The stream stream is used to read and write all data.
Make sure you call svn_stream_close() on the returned stream to ensure all data is flushed and cleaned up (this will also close the provided stream).
Read operations from and write operations to the stream perform the same operation: if expand is FALSE, both contract keywords. One stream supports both read and write operations. Reads and writes may be mixed.
If eol_str is non-NULL, replace whatever bytestring the input uses to denote line endings with eol_str in the output. If the input has an inconsistent line ending style, then: if repair is FALSE, then a subsequent read, write or other operation on the stream will return SVN_ERR_IO_INCONSISTENT_EOL when the inconsistency is detected, else if repair is TRUE, convert any line ending to eol_str. Recognized line endings are: "\n", "\r", and "\r\n".
Expand and contract keywords using the contents of keywords as the new values. If expand is TRUE, expand contracted keywords and re-expand expanded keywords. If expand is FALSE, contract expanded keywords and ignore contracted ones. Keywords not found in the hash are ignored (not contracted or expanded). If the keywords hash itself is NULL, keyword substitution will be altogether ignored.
Detect only keywords that are no longer than SVN_KEYWORD_MAX_LEN bytes, including the delimiters and the keyword itself.
Recommendation: if expand is FALSE, then you don't care about the keyword values, so use empty strings as non-NULL signifiers when you build the keywords hash.
The stream returned is allocated in result_pool.
If the inner stream implements resetting via svn_stream_reset(), or marking and seeking via svn_stream_mark() and svn_stream_seek(), the translated stream will too.
| SVN_DEPRECATED svn_error_t* svn_subst_stream_translated_to_normal_form | ( | svn_stream_t ** | stream, |
| svn_stream_t * | source, | ||
| svn_subst_eol_style_t | eol_style, | ||
| const char * | eol_str, | ||
| svn_boolean_t | always_repair_eols, | ||
| apr_hash_t * | keywords, | ||
| apr_pool_t * | pool | ||
| ) |
Set *stream to a stream which performs eol translation and keyword expansion when read from or written to. The stream source is used to read and write all data. Make sure you call svn_stream_close() on stream to make sure all data are flushed and cleaned up.
When stream is closed, then source will be closed.
Read and write operations perform the same transformation: all data is translated to normal form.
| SVN_DEPRECATED svn_error_t* svn_subst_translate_cstring | ( | const char * | src, |
| const char ** | dst, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| const svn_subst_keywords_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_subst_translate_cstring2() except that keywords is a svn_subst_keywords_t struct instead of a keywords hash.
| svn_error_t* svn_subst_translate_cstring2 | ( | const char * | src, |
| const char ** | dst, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| apr_pool_t * | pool | ||
| ) |
Set *dst to a copy of the string src, possibly performing line ending and keyword translations.
This is a variant of svn_subst_translate_stream3() that operates on cstrings.
If eol_str and keywords are NULL, behavior is just a byte-for-byte copy.
Allocate *dst in pool.
| SVN_DEPRECATED svn_error_t* svn_subst_translate_stream | ( | svn_stream_t * | src_stream, |
| svn_stream_t * | dst_stream, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| const svn_subst_keywords_t * | keywords, | ||
| svn_boolean_t | expand | ||
| ) |
Same as svn_subst_translate_stream2(), but does not take a pool argument, instead creates a temporary subpool of the global pool, and destroys it before returning.
| SVN_DEPRECATED svn_error_t* svn_subst_translate_stream2 | ( | svn_stream_t * | src_stream, |
| svn_stream_t * | dst_stream, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| const svn_subst_keywords_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| apr_pool_t * | scratch_pool | ||
| ) |
Similar to svn_subst_translate_stream3() except relies upon a svn_subst_keywords_t struct instead of a hash for the keywords.
| SVN_DEPRECATED svn_error_t* svn_subst_translate_stream3 | ( | svn_stream_t * | src_stream, |
| svn_stream_t * | dst_stream, | ||
| const char * | eol_str, | ||
| svn_boolean_t | repair, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | expand, | ||
| apr_pool_t * | scratch_pool | ||
| ) |
Copy and translate the data in src_stream into dst_stream. It is assumed that src_stream is a readable stream and dst_stream is a writable stream.
If eol_str is non-NULL, replace whatever bytestring src_stream uses to denote line endings with eol_str in the output. If src_stream has an inconsistent line ending style, then: if repair is FALSE, return SVN_ERR_IO_INCONSISTENT_EOL, else if repair is TRUE, convert any line ending in src_stream to eol_str in dst_stream. Recognized line endings are: "\n", "\r", and "\r\n".
See svn_subst_stream_translated() for details of the keyword substitution which is controlled by the expand and keywords parameters.
Note that a translation request is *required*: one of eol_str or keywords must be non-NULL.
Notes:
See svn_wc__get_keywords() and svn_wc__get_eol_style() for a convenient way to get eol_str and keywords if in libsvn_wc.
| SVN_DEPRECATED svn_error_t* svn_subst_translate_string | ( | svn_string_t ** | new_value, |
| const svn_string_t * | value, | ||
| const char * | encoding, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_subst_translate_string2(), except that the information about whether re-encoding or line ending translation were performed is discarded.
| svn_error_t* svn_subst_translate_string2 | ( | svn_string_t ** | new_value, |
| svn_boolean_t * | translated_to_utf8, | ||
| svn_boolean_t * | translated_line_endings, | ||
| const svn_string_t * | value, | ||
| const char * | encoding, | ||
| svn_boolean_t | repair, | ||
| apr_pool_t * | result_pool, | ||
| apr_pool_t * | scratch_pool | ||
| ) |
Translate the string value from character encoding encoding to UTF8, and also from its current line-ending style to LF line-endings. If encoding is NULL, translate from the system-default encoding.
If translated_to_utf8 is not NULL, then set *translated_to_utf8 to TRUE if at least one character of value in the source character encoding was translated to UTF-8, or to FALSE otherwise.
If translated_line_endings is not NULL, then set *translated_line_endings to TRUE if at least one line ending was changed to LF, or to FALSE otherwise.
If value has an inconsistent line ending style, then: if repair is FALSE, return SVN_ERR_IO_INCONSISTENT_EOL, else if repair is TRUE, convert any line ending in value to "\n" in *new_value. Recognized line endings are: "\n", "\r", and "\r\n".
Set *new_value to the translated string, allocated in result_pool.
scratch_pool is used for temporary allocations.
| SVN_DEPRECATED svn_error_t* svn_subst_translate_to_normal_form | ( | const char * | src, |
| const char * | dst, | ||
| svn_subst_eol_style_t | eol_style, | ||
| const char * | eol_str, | ||
| svn_boolean_t | always_repair_eols, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | special, | ||
| apr_pool_t * | pool | ||
| ) |
Translate the file src in working copy form to a file dst in normal form.
The values specified for eol_style, *eol_str, keywords and special, should be the ones used to translate the file to its working copy form. Usually, these are the values specified by the user in the files' properties.
Inconsistent line endings in the file will be automatically repaired (made consistent) for some eol styles. For all others, an error is returned. By setting always_repair_eols to TRUE, eols will be made consistent even for those styles which don't have it by default.
| svn_boolean_t svn_subst_translation_required | ( | svn_subst_eol_style_t | style, |
| const char * | eol, | ||
| apr_hash_t * | keywords, | ||
| svn_boolean_t | special, | ||
| svn_boolean_t | force_eol_check | ||
| ) |
Indicates whether the working copy and normalized versions of a file with the given the parameters differ. If force_eol_check is TRUE, the routine also accounts for all translations required due to repairing fixed eol styles.
1.7.6.1