Miva Script Compiler User s Guide. Revision 1.0

Transcription

1 Miva Script Compiler User s Guide Revision 1.0

2 Miva Corporation 5060 Santa Fe Street San Diego, CA Telephone: Telefax: This document and the software described by this document are copyright 2000 by Miva Corporation. All rights reserved. Use of the software described herein may only be done in accordance with the License Agreement provided with the software. This document may not be reproduced in full or partial form except for the purpose of using the software described herein in accordance with the License Agreement provided with the software. Information in this document is subject to change without notice. Companies, names and data used in the examples herein are fictitious unless otherwise noted. Miva is a registered trademark of Miva Corporation. Miva Script, Miva Script Compiler, Miva Order, Miva Merchant, Miva Virtual Machine, Miva Mia, Miva Empresa, the Miva blades logo, and the Miva Engine are trademarks of Miva Corporation. Windows is the registered trademark of Microsoft Corporation. All other trademarks are the property of their respective owners. This document was developed and produced in San Diego, CA, USA. MIVA CORPORATION WILL NOT BE LIABLE FOR (A) ANY BUG, ERROR, OMISSION, DEFECT, DEFICIENCY, OR NONCONFORMITY IN MERCHANT OR THIS DOCUMENTATION; (B) IMPLIED MERCHANTIBILITY OF FITNESS FOR A PARTICULAR PURPOSE; (C) IMPLIED WARRANTY RELATING TO COURSE OF DEALING, OR USAGE OF TRADE OR ANY OTHER IMPLIED WARRANTY WHATSOEVER; (D) CLAIM OF INFRINGEMENT; (E) CLAIM IN TORT, WHETHER OR NOT ARISING IN WHOLE OR PART FROM MIVA CORPORATION'S FAULT, NEGLIGENCE, STRICT LIABILITY, OR PRODUCT LIABILITY, OR (F) CLAIM FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES, OR LOSS OF DATA, REVENUE, LICENSEES GOODWILL, OR USE. IN NO CASE SHALL MIVA CORPORATION'S LIABILITY EXCEED THE PRICE THAT LICENSEE PAID FOR MERCHANT. MSC (Rev. 1.0) Miva Script Compiler 1.00 ii

3 Introduction The Miva Script Compiler assembles and compiles compatible Miva Script files into a cross-platform, web-based executable that runs under the Miva Virtual Machine. Benefits of the Miva Script Compiler: Fast execution speed Code obfuscation Code syntax checking Elimination or reduction of runtime syntax errors Access functions written in other programming languages (i.e. "C") Royalty-free application distribution Cross-platform execution The source code (.mv) is converted by the compiler into an intermediate format, the Miva Assembly Language (.mva), which can be used as a debugging tool. (Assembler documentation is beyond the scope of this guide.) The Miva Assembler converts the assembly language into compiled code (.mvc). Although, the assembly and compilation usually occur in only one step, an option exists to create the.mva. Miva Script Compiler Components The Miva Script Compiler consists of several command line executables, and built-in libraries. (Database libraries are available with the Miva Virtual Machine, depending upon platform.) Executables The following executables are located in the BIN directory: MVC The front-end for the Miva Script Compiler. For most uses, this is the program to compile the Miva Script files (.mv) into compiled files (.mvc). MVC1 The actual compiler, which converts the source.mv files into the intermediate Miva Assembly Language. MVASM The assembler which transforms the Miva Script Assembly files (.mva) into the final compiled files (.mvc). MSC

4 Built-in libraries: The built-in libraries are located in the BUILTINS directory: crypto.so (MVBCrypto.dll) Contains the functions and routines for SSL. file.so (MVBFile.dll) Contains the built-in file functions. math.so (MVBMath.dll) Contains the built-in math operators and functions. string.so (MVBString.dll) Contains the built-in string functions. system.so (MVBSystem.dll) Contains the tags, built-in system functions and variables. time.so (MVBTime.dll) The built-in time functions. API The Miva Script API consists of a set of routines that allow the C programmer to extend the behavior of the Miva Virtual Machine. MivAPI.lib (Windows platforms) mivapi.h (all platforms) Includes the type definitions, routine declarations, constant definitions, and structure definitions. Refer to the Miva Script 4.x API Reference Guide (as available). Installation Installing 1. Run the executable or untar the distribution file. The Windows version automatically installs to C:\MSC. 2. Add the fully qualified BIN subdirectory to your system s PATH. Windows: Depending on your Windows version, do one of the following: Add it to the Path System Variable in the Environmental Variables window. (From the Control Panel, open System Properties, click Advanced Tab, then click Environmental Variables.) OR Add the Path in autoexec.bat. (You may need to restart your system.) Unix: Add the /bin/ directory to the PATH variable. 3. Enter the MVC_LIB System Variable, with the value pointing to the fully qualified BUILTINS directory. (On Unix this could go in the.profile,.cshrc,.bashrc. On Windows, enter it as in previous step.) MSC

5 License and Registration After installation, a license needs to be generated for each user. If the compiler is executed before the licensing and registration has been completed, the user will get the following text: The software was unable to verify that this is a properly licensed installation of the Miva Script Compiler. This may be due to one of the following causes: - Invalid or missing licensing information - The software is unable to determine your system or user name The Miva Script Compiler is licensed on a per-user basis. If you require additional licenses, they may be purchased from the Miva General Store. If you have already purchased a license for the Miva Script Compiler, registering the license will provide you with the required licensing information, and instructions on how to install the licensing information on your system. You may register your Miva Script Compiler license at compiler/register.mvc. Register the Compiler 1. Gather the following information: Username System name Enter the following at a command prompt to get the user and system names: MVSASM -I Miva Script Compiler License number The license number that came with your Miva Script Compiler purchase from Miva General Store. 2. Retrieve the verification string from the following URL: Enter the required Registrant Information. Enter the System Information (username, system name, and license). Copy the following four lines, which look similar to the following: U:username S:sysname L:LicenseNumber V:VerificationString Verification is a string that verifies that the previous three strings are valid, and is retrieved when you register the compiler. 3. Save the license file to one of the following locations. MSC

6 The Compiler will look for the license file locate first at: Unix /home/usr/.msc_license, then /usr/local/miva/msc_license.dat, andthen /usr/lib/msc_license.dat, and finally in /etc/msc_license.dat. Windows file specified in the registry key "\HKEY_LOCAL_MACHINE\SOFTWARE\Miva\Miva Script Compiler\License File", then c:\msc\msc_license.dat, then finally c:\winnt\system32\msc_license.dat Running the Compiler Miva Script Compiler runs from the command-line. In Windows, run the Command Prompt to open a text-based window. At the command line, entering MVC --help will display the usage and the available options. Usage and Options mvc [options] file... Options: --help Displays the help data --version Displays Miva Script Compiler version number and exits -B <directory Switch to override the value of the MVC_LIB directory. -w <warning> Suppresses warnings -W <warning> Enables warnings -X <warning> Abort compilation on warning -c Compile only (produces an.mva) <warning> may be one of: - One or more warning ids, separated by commas - The keyword all, which indicates all warnings You may also opt to run a batch utility or other program that allows you to control the compilation of multiple files. MSC

7 Error Codes The errors identify where the error occurred, in the assembly or compilation and if it is a warning or an error. Error Format The error format is as follows: "<filename>:<linenumber>:<errorcode>:<text>" Where: <filename> The name of the file in which the error occurred. <linenumber> The line number within the specified file. <errorcode> A two character value followed by a number (See Character Values) <text> The descriptive text Character Values First Character A = error during Assembly pass C = error during Compilation pass Second Character E = Error W = Warning Warnings Warnings, by default, do not halt compilation of the given Miva Script program. You can change this behavior by using the -X flag. 1 Unknown attribute name <value> 2 MvDO has a VALUE attribute with no NAME attribute; discarding result 3 Preferred operator data type does not match constant type; inefficiency or unexpected rounding may occur 4 Unrecognized parameter "<value>" to "<value>" attribute 5 Value in comma-separated list is used more than once 6 (tag name) does not use attribute (attribute name) These warning are disabled, by default, and can be enabled using the -W flag: 51 Value xyz does not have any effect for attribute <value> in compiled Miva Script MSC

8 Compiler Errors 101 Found end of file when looking for </MvCOMMENT> 102 Found <value> when looking for attributes. 103 Found operator <value> when looking for attribute value. 104 Found <value> when looking for equal sign. 105 Found <value> when looking for value. 106 Found end of file when looking for close quote. 107 Found end of file when looking for end of expression. 108 Found <value> when looking for double quote at end of expression. 109 Found <value> when looking for close tag identifier. 110 Found <value> when looking for close tag '>' symbol. 111 Found end of file when looking for --> 112 Too many <open close> parenthesis 113 Internal error 114 Expression not valid for MvLOCALIZED-TEXT LANGUAGE attribute 115 FILTER_TYPE and EXPRESSION_TYPE are compiler directives, and cannot be expressions 116 Function name can not be an expression 117 Expression not valid for that MIVA attribute This is for the ERROROUTPUTLEVEL, STANDARDOUTPUTLEVEL, and ERRORMESSAGE attributes. 118 Array index is not a positive integer 119 Found </MvASSIGNARRAY> without matching <MvASSIGNARRAY> 120 Nested MvASSIGNARRAY blocks are not allowed 121 </MvCOMMENT> found without matching <MvCOMMENT> 122 MvELSE without MvIF 123 Too many MvELSE clauses 124 </MvFUNCTION> found without matching <MvFUNCTION> 125 Nested MvFUNCTION declarations not supported 126 </MvIF> found without matching MvIF 127 Found MvLOCALIZED-TEXT inside a MvLOCALIZED-TEXT block 128 Found end MvLOCKFILE without matching start MvLOCKFILE 129 Found </MvSMTP> without <MvSMTP> tag 130 Found <MvWHILESTOP> outside of a <MvWHILE> block 131 MvCALL tag requires ACTION and METHOD attributes 132 MvCOMMERCE tag requires METHOD attribute 133 MvDO requires FILE attribute 134 Unknown filter type "<text>" Only "variable" or "expression" are valid values for the FILTER_TYPE attribute. 135 MvFUNCTION requires the NAME attribute 136 Function name "<name>" already defined 137 MvIMPORT requires FILE, FIELDS, and DELIMITER attributes 138 MvMAKEINDEX requires the INDEXFILE attribute 139 MvMAKEINDEX requires the EXPRESSION attribute 140 MvLOCALIZED-TEXT requires the LANGUAGE attribute 141 MvPOP requires the MAILHOST, LOGIN, PASSWORD, and DIRECTORY attributes 142 MvREVEALSTRUCTURE requires the DATABASE or the VARIABLE attribute MSC

9 143 Found closing <value> tag without matching start <value> For example, "Found closing MvWHILE tag without matching start MvWHILE." 144 <value> is already used as parameter name 145 Error in filter expression: (other error) 146 MvDIMENSION found outside of <MvASSIGNARRAY> block 147 MvCALLSTOP not in MvCALL block 148 MvCREATE requires the FIELDS attribute 149 MvCREATE requires the NAME and DATABASE attributes 150 MvCOMMERCESTOP not in MvCOMMERCE block 151 MvEVALUATE requires the EXPRESSION attribute 152 MvEXPORT requires the FILE, FIELD, and DELIMITER attributes 153 MvFUNCTIONRETURN outside of a MvFUNCTION block 154 MvHIDE requires the FIELDS attribute 155 MvIMPORTSTOP not in MvIMPORT block 156 MvLOCKFILE requires the FILE attribute 157 MvOPEN requires NAME and DATABASE attributes 158 MvOPENVIEW requires the VIEW attribute 159 MvPOPDELETE not in MvPOP block 160 MvPOPSTOP not in MvPOP block 161 MvQUERY requires the QUERY attribute 162 MvSMTP blocks can not be nested 163 MvSMTP tag missing FROM, TO, or MAILHOST attribute 164 Found </MvWHILE> without <MvWHILE> 165 Found <<value>> without matching </<value>> 166 Reached end of file without finding </MvFUNCTION> 167 Function name <value> not defined or recognized as an external function 168 Found ']' with no matching '[' 169 MvPRIMARY needs the NAME, VIEW, or INDEX attribute 170 Too many NAME attributes 171 Attributeisusedmorethanonce 172 Expected member name, found '(' 173 Found '.' when expecting a member name 174 MvELSEIF without matching MvIF 175 Found unexpected <value> in expression 176 </MvELSE> is not supported; use <MvELSE> or <MvELSE/>???xx 177 Operator <value> is obsolete 178 Expression has too many (operators operands) 179 Found ")" when expecting "]" 180 Function X takes Y parameters, called with Z parameters 181 Function name (name) must contain only letters, numbers, or underscores 182 (value) is not a valid unquoted constant. MSC

10 Assembler Errors 301 Only parameter directives are valid inside an external function declaration 302 String constant identifier "<value>" not found 303 System variable identifier "<value>" not found 304 Global variable identifier "<value>" not found 305 Various internal errors. 306 Only parameter directives are valid inside an external function declaration 307 Nested internal function declarations are not allowed 308 Duplicate function 309 Found.endfunction without matching.function 310 Parameter directive must be between.function and.endfunction directives 311 Duplicate string identifier <value> 312 Found end of file inside a.function declaration 313 Unable to resolve function <function name> 314 Unrecognized directive or punctuation mark: <character> 315 Unrecognized operation code: <value> 316 Duplicate label: <value> 317 Unexpected colon 318 Unexpected comma 319 Expected label, directive, or operator, found a number: <value> 320 Expected label, directive, or operator, found a quoted string 321 Expected directive identifier 322 Expected quoted string, got <value> 323 Expected symbol 'value' or 'reference' for parameter type 324 Error in localization string 325 Error in Localized Languages 326 Expected comma, found <character> 327 Unknown parameter call type: <value> 328 Unrecognized function qualifier <value> 329 Duplicate parameter identifier 330 Duplicate variable 331 Duplicate variable identifier 332 Reference to local <value> not resolvable 333 Label <value> not defined 334 Infinite loop detected at code offset <value> MSC