Macros

macros are defined as name value pairs, where a value replaces the name during the barcodereadercli session this process is called macro expansion macros are used specify names of input and output file/folder names select data presented in the output macro format and expansion rules in most cases, a macro is referenced by its name enclosed in curly brackets \`{macro name}`\ macro names are case insensitive general macro references format is \`{namespace macro name?/format}`\ where \`namespace `\ optional namespace to distinguish macros with the same name defined in multiple categories \`macro name`\ the required name of a macro \`?`\ optional mark to expand undefined macro to an empty string without this mark, an undefined macro causes a runtime error \`|format`\ optional macro expansion control available formats \`#xn`\ duplicate macro value n times \`#n` \ expands to the name of the macro \`#v`\ expands to the value of the macro examples \`{tab|#x3}` \ expands to 3 tab characters \`{dob?|#n is #v}`\ expands to a string \`dob is` `user date of birth`\ , if the current barcode contains driver's license data; otherwise, it expands to an empty string \`{path temp}{path sep}myoutput xml`\ expands to a \`myoutput xml`\ file path located in a temporary folder, e g /tmp/myoutput xml \`{bc page}` \ expands to the page number in a file, where a barcode is located macro categories session macros the session macros remain constant in the course of the barcodereadercli session the namespace for these macros is \`prg `\ name value description \`path tmp`\ system temporary folder path (without terminating path separator} \`path sep`\ path separator character \ on windows, / on linux \`host`\ host computer name \`app filename`\ barcodereadercli file name \`app version`\ barcodereadercli version \`start date`\ session start date format yyyy mm dd \`start time`\ session start time format hh\ mm\ ss \`nl`\ new line character \`cr`\ carriage return character \`eol`\ carriage return + new line characters \`tab`\ tab character \`bom`\ utf 8 byte order mark (bom) environment variables selected environmental variables are converted to a macro the namespace for these macros is \`env `\ user macros the user macros are defined using \ ` d="``macro name=macro value"`\ option on a command line or in the configuration file the namespace for these macros is \`user `\ the value of user macros referenced in filename options can reference other user macros (recursive expansion ) source macros the source macros are associated with the currently processed source the namespace for these macros is \`source `\ name value description \`path`\ source path specified on a command line \`type`\ source type file , folder , url \`files`\ number of files found in the source \`bc count`\ total number of found barcodes file macros the file macros are associated with the currently processed image file the namespace for these macros is \`file `\ name value description \`path`\ image file path \`filename`\ filename section of path \`basename`\ filename without extension \`ext`\ the extension portion of the filename \`folder`\ path to a folder containing the image file \`pages`\ number of pages in a file \`format`\ image file format \`size`\ size of image file \`bc count`\ total number of found barcodes page macros the page macros are associated with the currently processed image page the namespace for these macros is \`page `\ name value description \`page`\ page number (1 based) \`bpp`\ bits per pixel \`width`\ page width in pixels \`height`\ page height in pixels \`hdpi`\ horizontal dpi \`vdpi`\ vertical dpi \`compr`\ page compression \`path`\ path to the image file containing this page \`bc count`\ total number of found barcodes barcode macros the barcode macros are associated with the currently processed barcode the namespace for these macros is \`bc `\ name value description \`ind`\ barcode index on a page \`text`\ barcode text value as utf 8 string \`data`\ barcode value as a byte array encoded as base 64 string \`length`\ barcode value length \`type`\ barcode type \`rotation`\ barcode rotation \`encoding`\ the encoding used to convert barcode data to utf 8 text \`tbr`\ tbr code used to read this barcode (not present if code was not set) \`path`\ image file path \`abspath`\ image file absolute path \`page`\ page number (1 based) \`mod`\ barcode module size in pixels \`skew`\ barcode skew \`rectangle left`\ the left coordinate of the encompassing rectangle \`rectangle top`\ the top coordinate of the encompassing rectangle \`rectangle right`\ the right coordinate of the encompassing rectangle \`rectangle bottom`\ the bottom coordinate of the encompassing rectangle \`corners tl x`\ x coordinate of the top left corner \`corners tl y`\ y coordinate of the top left corner \`corners tr x`\ x coordinate of the top right corner \`corners tr y`\ y coordinate of the top right corner \`corners bl x`\ x coordinate of the bottom left corner \`corners bl y`\ y coordinate of the bottom left corner \`corners br x`\ x coordinate of the bottom right corner \`corners br y`\ y coordinate of the bottom right corner driver's license macros the driver's license macros are associated with the currently processed barcode; it contains driver's license or id card data the namespace for these macros is \`dl `\ name value description \`last`\ cardholder family name \`first`\ cardholder first name \`middle`\ cardholder middle name \`dob`\ cardholder's date of birth \`eyes`\ cardholder eyes color \`hair`\ cardholder hair color \`sex`\ cardholder sex \`height`\ cardholder height in ft and inch \`weight`\ cardholder weight in pounds \`street`\ cardholder street address \`city`\ cardholder city \`state`\ cardholder state or province \`postal`\ cardholder zip or postal code \`id`\ card id number \`issued`\ card issue date \`expires`\ card expiration date