| 1 | Sourcecode for OdinBug 0.5.5
|
|---|
| 2 | ============================
|
|---|
| 3 |
|
|---|
| 4 |
|
|---|
| 5 | A. How to compile OdinBug
|
|---|
| 6 |
|
|---|
| 7 | 1. Create a project folder named OdinBug in your
|
|---|
| 8 | VX-REXX projects folder.
|
|---|
| 9 |
|
|---|
| 10 | 2. Unzip this OdinBugSrc055.ZIP in this folder.
|
|---|
| 11 |
|
|---|
| 12 | 3. Open OdinBug.VRP using VRXedit.
|
|---|
| 13 |
|
|---|
| 14 | B. Conventions that are used by me in this project:
|
|---|
| 15 |
|
|---|
| 16 | First of all, the source is not well documented, sorry,
|
|---|
| 17 | this will improve in the future.
|
|---|
| 18 |
|
|---|
| 19 | 1. Variables, GUI object names and INI keys for one
|
|---|
| 20 | information should have one name, for instance:
|
|---|
| 21 |
|
|---|
| 22 | Variable name: Logfile
|
|---|
| 23 | GUI Object: EF_Logfile (indicating an Entryfield)
|
|---|
| 24 | INI-Key: Logfile (case sensitive!)
|
|---|
| 25 |
|
|---|
| 26 | I think there are two exceptions to this rule in the
|
|---|
| 27 | project (these were accidents).
|
|---|
| 28 |
|
|---|
| 29 | 2. I do not store any information directly in a GUI object,
|
|---|
| 30 | i.e. for every purpose, there exists a variable and (if
|
|---|
| 31 | necessary) a GUI object. Appropriate measures have to be
|
|---|
| 32 | taken to syncronize these two (or three). Check for event
|
|---|
| 33 | routines tied to the entryfields on the settings page and
|
|---|
| 34 | for the subroutines _GUInit, _GUIEMailInit, _GUIRedraw and
|
|---|
| 35 | _GUIRedraw2 to get an idea how I do this.
|
|---|
| 36 |
|
|---|
| 37 | Please, no discussion, whether this is sensible or not.
|
|---|
| 38 | I want it this way in OdinBug, and I ask you to respect
|
|---|
| 39 | this (but you are welcome to tell me how to do it better
|
|---|
| 40 | for my next program).
|
|---|
| 41 |
|
|---|
| 42 | 3. User defined subroutines should start with an underscore.
|
|---|
| 43 | Note: The VX-REXX IDE has a bug, which makes it crash
|
|---|
| 44 | if a routine beginning with underscore is deleted.
|
|---|
| 45 | Sorry, I did not know that before I introduced this
|
|---|
| 46 | convention.
|
|---|
| 47 |
|
|---|
| 48 | 4. OdinBug does not (and should not) write anything to OS2.INI
|
|---|
| 49 | or OS2SYS.INI! Everything should be written to OdinBug.INI
|
|---|
| 50 | residing in the same directory as OdinBug.EXE.
|
|---|
| 51 |
|
|---|
| 52 | 5. OdinBug must run without it's INI file. There has to be a
|
|---|
| 53 | reasonable default value for every single INI entry. If the
|
|---|
| 54 | default value is empty, there has to be a line of comment
|
|---|
| 55 | about that in the subroutine _INIRead.
|
|---|
| 56 |
|
|---|
| 57 | C. Please, share any changes you make, with me, because OdinBug
|
|---|
| 58 | is still under development and I do not want different branches
|
|---|
| 59 | with different bugs/features.
|
|---|
| 60 |
|
|---|
| 61 | D. AUTHOR:
|
|---|
| 62 |
|
|---|
| 63 | Herwig Bauernfeind, 02-12-2001
|
|---|
| 64 | EMail: herwig.bauernfeind@aon.at
|
|---|
