home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 April / PCWorld_2005-04_cd.bin / software / vyzkuste / autoit / autoit-v3-setup.exe / Extras / Readme.txt < prev   
Encoding:
Text File  |  2005-01-14  |  7.1 KB  |  217 lines
  1. ----------------- INSTALLATION ------------------
  2.  
  3. After AutoIt3 installation the Translator files are in the "Extra\V2 to V3 Converter"
  4. You can run thee _Shortcut_creation.au3 script to create a shortcut on the desktop.
  5.  
  6. And just click select the file to be translated.
  7.  
  8. Good conversion and forget about AutoItV2 :)
  9.  
  10. REPORTS problem with the sample reproducing the error or the faulty script itself
  11.     don't forget to join the AutoItV2toV3.dat used if MODIFIED
  12. TO JPaul-Mesnage at ifrance.com or through the http://www.autoitscript.com/forum
  13.  
  14. -------------------- HISTORY --------------------
  15. 1.06    - Added    Ignore labels not referenced
  16.     - Fixed    default internal variable initialisation as for stringcase
  17.  
  18. 1.05    - Fixed    Bad variable like a(%i%)
  19.  
  20. 1.04    - Added    Fileselection to choose file to be converted
  21.     - Fixed    Launching by drag & drop on AutoItV2toV3.exe
  22.  
  23. 1.03    - Added    Update #include filename extension to .AU3
  24.     - Added    use "include".ini function definitions if found in the folder
  25.         containing the file being translated
  26.     - Added    Continueloop in while statement
  27.         for ScriptKitty satisfaction (I hope !!!)
  28.         just add label in the [While] in *.ini
  29.     - Added    /1 option to execute only one translation
  30.         default now is 2 runs with the first one generating references
  31.     - Added    Define constant parameter in function definition
  32.          func ( const) as opposed to func ( $par)
  33.         will suppress SetEnv, Par, const translation except if /G used
  34.     - Added    varname return by a function can be derived from a const param
  35.          func ( const) = ret$const
  36.     - Added redefinition of internal variable. Can be used in case homonymy.
  37.          ex desktop = desktop will suppress internal reference to @desktop
  38.             and produce a $desktop translation for %desktop%
  39.  
  40.     - Fixed variable name containing "-$" (substitution with "_")
  41.  
  42. 1.02    - Fixed %i% = $CmdLine[$i]
  43.     - Fixed " " after a %variable% in a string (sorry for @comspec !!!)
  44.     - Fixed comment line with only ";" no more skipped
  45.     - Fixed IfEqual,IfNotEqual referencing __cmp() compatibilty function
  46.     - Fixed filename can be protected with " to contain space character
  47.     - Fixed #include generation
  48.     - Fixed empty value
  49.          for SetEnv, Send, Splash, String..., File...,Ini..., Reg...
  50.     - Fixed String generation (starting with a protected char)
  51.  
  52.     - Added %comspec% = @Comspec
  53.     - Added %DosEnvironment% = EnvGet('DosEnvironment')
  54.     - Added Global variables generation when needed
  55.     - Added Global or Environment variable can be predefined in *.ini
  56.         /R will set what it thinks is the best !!!
  57.     - Added correct error code handling for
  58.             FileReadLine, RegRead, StringReplace, StringGetPos
  59.     - Removed /E Kamikaze option (2 runs with /R should be save)
  60.     - Added /G force extra code Generation for ERRORLEVEL checking
  61.         for those which get trouble with 2 runs
  62.     - Added    a%i% -> $a[$i]. Only works if it is a variable type in V2
  63.          For Tylo satisfaction and my AutoItV2 code too !!!
  64.     - Added Global variable renaming predefinition in *.ini
  65.          For handling simple case a%i% -> $ret to avoid __idx()
  66.          Only works if it is a variable type in V2 SetEnv, a%i%
  67.     - Added Function parameter/return predefinition in *.ini
  68.  
  69. To be done
  70.  
  71. 1.01    - Added Support "," in last parameter (Send, Msgbox, SetEnv, ...)
  72.     - Added simple DO Until
  73.     - Added %i% command line parameter
  74.     - Added /Q /E options
  75.  
  76.     - Fixed string starting with special variable
  77.     - Fixed WinMinimize with empty Text
  78.         WinMaximize
  79.         WinRestore
  80.         WinShow
  81.         WinHide
  82.     - Fixed SplashTextOff
  83.  
  84. 1.00 Initial release
  85.  
  86. -------------- Command Line SYNTAX --------------
  87.  
  88.     Translator AutoItV2toV3 [Version 1.0.6]
  89.     (C) Copyright 2004 J-Paul Mesnage.
  90.  
  91. AutoItV2toV3 source [/C] [/R] [/1] [/Q] [/G] [/P] [/S] [/1] [deffile]
  92.  
  93.   /C    insertion of AutoIt V2 source line
  94.   /R    create/update AutoIt V2 label Reference file (*.ini)
  95.         will be reused in the next translation.
  96.         
  97.   /1    do only one phase translation.
  98.       By default Translator is called twice first time forcing /R.
  99.       If /R is not initialy requested, the *.ini will not be changed.
  100.  
  101.   /Q    Quit translation without stopping at completion
  102.  
  103.   /G    force extra code Generation for ERRORLEVEL checking
  104.       or for SetEnv used for function call constant parameter.
  105.  
  106.   /P    trace AutoIt V2 Parameters (for trouble shooting)
  107.   /S    trace AutoIt V3 Statement  (for trouble shooting)
  108.  
  109. source    filename to be translated.
  110.     AutoItV3 script will be created in the same directory suffixed by .AU3
  111.  
  112. deffile    allow to override the standard AutoItV2toV3.dat
  113.     by default located in the same directory as AutoItV2toV3.exe
  114.  
  115. ----------------- *.ini SYNTAX ------------------
  116. /R option will generate/update a *.ini
  117.    sometime it helps to force some labels before the first run
  118.     I found the forcing func label for Stop followed by Exit
  119.     very fruitful to solved:
  120.         V2                 V3        *.ini
  121.     Goto, Stop        Stop ()        [Func]
  122.     ...                    Stop
  123.     Stop:            Func Stop ()
  124.     Exit            Exit
  125.                 EndFunc
  126.  
  127. Each section are terminated by a blank line
  128. No blank line inside section
  129. Inside each section, each line will defined the type of the Label/Variable
  130.  
  131. [Func]
  132. FuncLabel1
  133. FuncLabel2 ( $par1,  ... ) = $retvar    ; par and retvar are optional
  134. FuncLabel3 ( const1, ... ) = $retvar    ; const is the variable define
  135. ...                    ; in the corresponding SetEnv
  136. ...                    ; preceeding the Gosub
  137. FuncLabel4 ( const, ... ) = str$const    ; const is as above
  138. ...                    ; the translated return value
  139. ...                    ; will be stored in a variable
  140. ...                    ; whose name is concatenation
  141. ...                    ; of "str" and const value
  142.  
  143. [FuncDo]
  144. as [Func] but forcing a Do at the begining
  145.  
  146. [FuncWhile]
  147. as [Func] but forcing a While at the begining
  148.  
  149. [DoUntil]
  150. DoUntilLabel1
  151. ...
  152.  
  153. [While]
  154. WhileLabel1
  155. ...
  156.  
  157. [NoRef]
  158. NoRefLabel1
  159. ...
  160.  
  161. [Global]
  162. GlobalVariable1
  163. GlobalVariable2[dim]            ; "[dim]" is optional
  164. GlobalVariable3 = NewName        ; The AutoItV2 variable will be renamed
  165. ...                    ; in "NewName"
  166.  
  167. [Environment]
  168. EnvironmentVariable1
  169. ...
  170.  
  171. [ReturnError]
  172. Linenumber1                ; input source linenumber where the
  173. ...                    ; setting of error code will be forced
  174. ...                    ; to go around case the checking
  175. ...                    ; is not generated the line after
  176.  
  177. ----------------- Sample *.ini ------------------
  178. [Func]
  179. MyRoutine
  180. MyRoutineWithPar ( $par1, $par2)
  181. MyFunction ( $par1) = $ret
  182. MyFunctionWithConstant ( par1) = $ret
  183.  
  184. [Global]
  185. _var
  186. _%_Str% = _str_
  187.  
  188. [Environment]
  189. USERPROFILE
  190. ProgramFiles
  191.  
  192. --------------------- HINTS ---------------------
  193. 0. don't expect a 100% translation.
  194.  
  195. 1. source MUST run under AutoItV2 without ERRORS.
  196. 2. simple "if then else endif" will be detected even nested.
  197. 3. simple "while wend" even nested.
  198. 4. it is better to have a label only reference once.
  199.  
  200. 5. for script with ERRORLEVEL checking not working use /G to generate extra code
  201.    or if a SetEnv corresponding to a constant parameter is badly suppress
  202. 6. use /1 to run only one run translation at a time.
  203.    Needed if the *.ini must be changed manualy before second run
  204.  
  205. 7. noodle GOTO will not translate.
  206. 8. combined endif GOTO may not be translated
  207.     ex: if...,Goto, endif1
  208.         ...
  209.         if..., Goto, endif1
  210.             ...
  211.             if..., Goto, else1
  212.                 ...
  213.                 goto, endif1
  214.             else1:
  215.                 ...
  216.         endif1:
  217.