1. Overview

FreshLib is an assembly library aimed to ease the development of assembly language applications, freely portable between different platforms, such as Win32 or Linux.

The library is coded in flat assembler syntax and is intended to be easily used within Fresh IDE, although it could be used for plain FASM development.

The library consists of two layers: one, that is OS dependent and a second one that is OS independent. The OS dependent layer is very small, in order to help porting it for different OSes. This layer only makes interface to the core OS functions, such as memory allocations, file access, drawing functions, simple window management etc.

The OS independent layer is responsible for the main application functionality allowing creation of different kind of windows and controls, although it could be used for plain FASM development.

FreshLib is mainly intended for developing GUI applications, as they are the most challenging to be ported across different platforms. FreshLib is also created with visual programming in mind, so it contains a flexible, event driven and OS independent template engine allowing visual creation of application user interfaces.

FreshLib is in early development stage and probably will be changed many times in order to reach their objectives: to be small, fast and easy to use.

The main intention is to keep the bloat off the library, but containing all necessary accessories for comfortable programming of a very wide range of applications.

The architecture of FreshLib is open and it can be freely expanded with other libraries without increasing the size of applications. In other words, only those parts of the library that are effectively used will be compiled on the final executable.

2. About this manual

This manual is a "work in progress". Any part of it can be changed at any time.

Of course, some of the libraries described in this document are more stable and finished like the macro, system and data libraries. Therefore, the chapters about these libraries are less likely to be changed. Other libraries (like graphics and GUI), will be heavily modified so the manual will be changed accordingly.

3. Structure of the library.

FreshLib contains many code and macros libraries, structured hierarchically and depending on each other. Here is shown a part of the library directory tree:

    freshlib/
        compiler/
            Linux/
            Win32/
        data/
            Linux/
            Win32/
        dialogs/
            Linux/
            Win32/
        ...

The library is structured to support different platforms transparently. You can see, that the tree consists of main sub-directories, that contains OS independent libraries, separated by topics. For example system subdirectory contains libraries for accessing system resources such as memory, files, etc. data contains libraries for data handling and so on. Every topic directory have also several sub-directories, that contains OS dependent code these directories are named after the platform they serve. (In this moment only Linux and Win32 OSes are supported).

4. Compiler setup for FreshLib use.

You can use any FASM compiler to compile applications that uses FreshLib. In order to be compiled properly, FreshLib needs environment variables named lib and TargetOS to be defined.

The variable lib contains the path to the main directory of FreshLib and the variable TargetOS contains the target platform, the application will be compiled for. The value of TargerOS is identical to the name of OS dependent directories in FreshLib.

Currently, there are 3 of them: Win32, Linux and KolibriOS. Setting TargetOS to some of these values will make the program to be compiled for this OS.

There are several ways these variables to be defined, depending on the compiler you use FASM, FASMW or Fresh IDE:

• These variable can be defined in the OS environment - see your OS documentation for details. this approach is more universal - it works for all kind of FASM compilers. The main drawback is that you have to use OS specific commands and probably will have to edit some system files.

• Definition in the section [environment] of "fasm.ini" or "Fresh.ini" file, depending on the IDE you are using. This approach works for both FASMW and Fresh IDE, but in Fresh, the same effect can be done from inside the IDE. Besides, defined this way, the environment variables becomes "global" - active for all projects compiled with FASMW or Fresh.

• From inside Fresh IDE.

In Fresh IDE, the environment variables are named "alias", because they serve to provide short alias for the file paths. Two types of alias (environment variables) lists are supported by Fresh: global aliases and project aliases. Global aliases are defined in the IDE options dialog: Options|IDE options|Aliases. Here is the screenshot of this dialog:

The global aliases are active for every project compiled with Fresh and are stored in the Fresh.ini file, inside the Fresh program directory.

Project aliases are defined in the Project options dialog: Project|Project options or from the project manager, click on the button Settings at the top and select Project options. The project options dialog is shown on the following screenshot:

The project aliases are stored inside the project file (.fpr) and they are project specific.

For FreshLib it is not important what list will be used, but it is more convenient for lib variable to be defined in the global list and for TargetOS variable to be defined in the project aliases. In such way the common parameter (the place of the library) will be set once for all projects, and the particular parameter (the target OS) will be set separately for every project.

Also, there is very convenient way of changing the value of project aliases — if several values are specified in the project alias, separated with | char (for example: Win32|Linux), Fresh will provide fast switching between these values from the project manager options menu, as shown on the picture:

When Fresh searches for needed alias names, during the compilation, it searches first in the project aliase list, then the global aliases and at the end, the OS environment variables. Of course, if the alias is not found on these places, the compilation fails with error.

5. FreshLib compiling options

FreshLib uses some options in order to set the behavior of the compiler and the different macro libraries. These options are defined as a local constants of the label "options." Here is a list:

options.FastEnter controls the behavior of the proc macro.

When options.FastEnter = 1 the procedure entry/leave code will be created with faster, but bigger push ebp/pop ebp instructions.

When options.FastEnter = 0 — enter/leave instructions are used.

options.ShowSkipped controls the information displayed during compilation.

When options.ShowSkipped = 1 the compiler will display in the output window the procedures that are not compiled because they are not used in the program.

options.ShowSizes controls the behaviour of the DispSize macro.

When options.ShowSizes = 0 the macro DispSize will be disabled.

options.DebugMode controls the behaviour of the debug macros.

When options.DebugMode = 1 the macros from simpledebug library will generate debug code and debug console will be created on running the application.

When options.DebugMode = 0 these macros will not generate code and the debug console will not be created.

6. FreshLib code conventions

6.1. Naming conventions

1. The names prefixed with one or more underscores ("_") are not recomended for use by the user. These are internaly used labels that can be changed later. More underscores in the prefix - more "internal" is the given identifier.

For example one underscode ( like this: _AlmostPrivate) means - "use it carefully".

Three underscores (for example ___SomeVeryPrivateLabel) means - don't use it at all. It is for internal use only and will be changed later!

2. The names are considered to be used with code completion editor - i.e. there is no long equal prefixes of the names, but there are short "class" prefixes. For example most of the procedures in StrLib begin with "Str" prefix.

3. In general, FreshLib uses CamelCase naming convention, with constants in lowerCamelCase and procedures in HigherCamelCase.

4. All local labels and procedure arguments are prefixed with dot — ".";

5. Almost all of the struct and all of object definitions are prefixed with "T" prefix — for example TTimer or TButton

6. The file names convention. All file names with extension .inc doesn't contain any code or data definition. Only macro and constants definitions are permitted.

The files with '.asm' extension can define code and data. Although, the code and data in FreshLib can exists in the compiled binary, only if they are used. Not used data or code, included in the binary should be considered a bug.

6.2. Register preserving convention

1. The rule is - preserve all you are using. All procedures in FreshLib preserves all registers, except these used for returning result values.

Note: There is some small retreat from this rule - in the object handling procedures, some register are preserved internaly, so the user may not preserve them in its code. See object.asm library for details.

2. CF is widely used for returning error status or boolean result. As a rule CF=0 means no error; CF=1 means error.

The use of CF is described always in the description of the respective procedures.

3. The procedures can return result in more than one register. As a rule, EAX is the result register for the most procedures, but sometimes other registers are used - in order to provide better interface for assembly programming.

For example number of procedures return X,Y values in EAX, EDX registers.

EAX — commonly used for returning 32bit values;

EDX — second choise - used together with EAX for 64 bit values, or as a second returned value.

ECX — usually some count. For example if EAX returns pointer to some memory, ECX will contains the data size. See LoadBinaryFile for example.

7. Using FreshLib

There are only two files, the user should include in order to use FreshLib. They are both located in the "freshlib" directory, usually referred by %lib% directory alias.

These files are:

%lib%/freshlib.inc - contains all macro and OS dependent equates definitions.

%lib%/freshlib.asm - contains all code of FreshLib. Only the used code will actually be included in the result binary.

The minimal application with FreshLib have following code:

include "%lib%/freshlib.inc"

@BinaryType GUI

include "%lib%/freshlib.asm"

start:
        InitializeAll

        ; Place your code here

        FinalizeAll
        stdcall TerminateAll, 0 

The macro @BinaryType, will be explained later in the next chapter.

8. FreshLib directory "compiler/"

This directory contains only one macro library: "executable.inc"

8.1. "executable.inc" library

This library defines the macros that are going to be used for creating the main structure of the program. The implementation of these macros is OS dependent, as long as the type of the executable file is OS dependent: PE for Win32 and ELF for Linux. The use of the library, however is OS independent and is common for all supported OSes. Depending on the value of TargetOS alias, the library will create PE executable or DLL (%TargetOS%='Win32'), or ELF executable or shared library (%TargetOS%='Linux')

NOTE: Every of the macros from this library must used only once in the program.

macro @BinaryType type, model

This macro sets the type of the executable. The argument type can accept one of the following values: GUI, console or DLL.

The argument model is optional and determines the memory model the compiler will follow for the data sections of the program. The possible values are in general OS dependent, but some are in common use:

default - use the default model for the given binary type. The data sections are usually separated from the code section.

compact - try to make the binary as small as possible, merging data, import, export and code sections if possible.

manual - does not automatically create data or import sections. The programmer is responsible for creating these sections.

This macro also begins the main code section of the executable and defines the entry label of the program. The entry label is fixed to start: if the binary type is console or GUI and EntryPoint if DLL.

For example, following code will tell the compiler to compile the program as a GUI application with default memory model:

include '%lib%/freshlib.inc' @BinaryType GUI

macro create_all_imports

This macro is for internal use only. The user must not call it, unless the memory model in @BinaryType is set to manual.

This macro creates a data structure for all imported from dynamic libraries functions. The data is placed where the macro is called.

9. FreshLib directory "equates/"

"allequates.inc" library.

This library defines all constants and structures needed for OS dependent parts of FreshLib.

Actually, the user should never use these constants and structures in the portable program.

The constants and structures that the user should use are defined in the respective libraries, not in "allequates.inc".

This library will be included automatically by "%lib%/freshlib.inc" file, so the user should not care about this library at all.

10. FreshLib directory "imports/"

This directory contains include files with import definitions for different DLLs. As long as FreshLib handles the import sections automatically, the user should never use these files explicitly.

FreshLib contains very big catalog of shared libraries for Windows and decent set of Linux shared libraries. The import macros used by FreshLib includes in the import section of the program, only the functions used by the program, so it will never define redundant import items.

11. FreshLib directory "macros/"

This directory contains several libraries that provides common convenience functions to be used with big assembly projects.

All these libraries will be included automatically in "%lib%/freshlib.inc" file.

There is no overhead including all these libraries, because there is no code to be generated, just macro definitions. There is a little delay in compile time but thanks to fasm's speed, it is barely noticeable.

Lets examine each one of these libraries.

11.1. "_stdcall.inc" library

In general this library provides ways of definition and invoking of the procedures with argument passing through the stack. It supports STDCALL and CCALL calling conventions.

11.1.1. Procedure definition macros

macro proc name, [arg]

macro begin

macro endp

macro return

macro cret

macro locals

macro endl

These macros define a procedure, create a stack frame for the local variables and define symbolic names for the arguments. The macro "proc" defines the global label "name" as a name for the procedure. All arguments and local variables are defined as a local labels with regard to the name of the procedure. That is why all arguments and local variables must have names beginning with dot.

Between the line with proc and begin, any number of local variables can be defined. The macro begin marks the begining of the procedural code.

The macro endp marks the end of the procedural code.

The return from procedure instruction is provided by macros return or cret depending on the calling convention we want to use: return clears the arguments from the stack and cret does not.

Inside the procedure, a secondary stack frame can be allocated with the pair locals and endl. All data definitions, enclosed between these macros will define a secondary stack frame that is a continuation of the stack frame defined between proc and begin.

Any number of locals and endl pairs can be used, but all of these secondary stack frames will overlap between each other. This feature is specially intended to provide savings of stack space and at the same time, to provide talking variable names for the different parts of more complex procedures.

For example (in Win32) let we have complex window procedure that have to process multiple messages.

One of the message handlers may need one variable .rect.

Another message handler may need two variables called .point1 and .point2.

But the procedure as a whole is never going to need all those variables at the same time, because it process only one message at a time. On the other hand it may need the variable .ctrldata for every message processed. The optimal solution is to define the variables as shown in the following example:

proc CtrlWinProc, .hwnd, .wmsg, .wparam, .lparam
    .ctrldata dd ?
    begin
        invoke GetWindowLong, [.hwnd], GWL_USERDATA
        mov    [.ctrldata], eax

        cmp    [.wmsg], WM_MESSAGE1
        je     .message1
        cmp    [.wmsg], WM_MESSAGE2
        je     .message2
        return

    .message1:
    locals
      .rect RECT
    endl
        ; do something.
        return

    .message2:
    locals
      .point1 POINT
      .point2 POINT
    endl
        ; do something. 
        return
    endp

The assignment of the stack memory for the above example is shown in the table:

Address 	  Stack frames
 	Common 	 Locals 1 	Locals 2
EBP-20 		 .rect.left 	.point1.x
EBP-16 		 .rect.top 	.point1.y
EBP-12 		 .rect.right 	.point2.x
EBP-8 		 .rect.bottom 	.point2.y
EBP-4 	.ctrldata 	

As you can see, .rect occupies the same memory as .point1 and .point2, but .ctrldata is never overlapped and exists independently.

As a general rule, you have to use the definitions between "proc" and "begin" for local variables that are used in every call of the procedure and separate locals/endl definitions for variables needed for the particular branches inside the procedure. This approach will always provide the optimal size for the locals stack frame.

macro interface name, [arg]

macro body name

Sometimes, especially when portable code is to be created, one needs to define the interface part of the procedure in some place and the actual body in another place of the source code (even in separate file).

In this case the macro interface and body are to be used.

interface has the same syntax as proc, but does not need other elements ( begin, endp, etc.)

body needs only the name of the procedure (without the arguments).

Here is small example:

    interface SomeProc, .arg1, .arg2

    ....
    ....

    body SomeProc
    begin
          mov   eax, [.arg1]
          add   eax, [.arg2
          return
    endp

macro initialize

macro finalize

The macros "initialize" and "finalize" defines one special type of procedures that, during compilation are registered in a two separate lists - one for "initialize" and one for "finalize" procedures. Procedures defined with "initialize" and "finalize" must have no any arguments.

After that, using the macros "InitializeAll" and "FinalizeAll", all these procedures can be call at once. "initialize" procedures are call in the order of their definition and "finalize" procedures in reverse order.

These macros provides standard and consistent way for initialization and the finalization of the libraries and modules of the application.

FreshLib uses this mechanism and the user is free to use it as well.

11.1.2. Procedure call macros.

macro stdcall proc, [arg] macro ccall proc, [arg] macro invoke proc, [arg] macro cinvoke proc, [arg]

These macros call the procedures with STDCALL and CCALL calling convention.

stdcall macro pushes the arguments to the stack in reverse order and then call the procedure with label proc. As long as the macro "stdcall" does not provide any stack cleanup (this duty is assigned to the procedure) the arguments can be pushed in free manner using, for example, separate push instructions for part of the arguments and arguments in the stdcall line for the remaining arguments.

This approach can be very convenient in some cases. For example see the following source:

    stdcall CreateSomeObject
    push    eax
    stdcall DoSomething
    stdcall DeleteSomeObject

Here, the procedure DoSomething changes the value of eax, so the handle is saved in the stack. The procedure DeleteSomeObject needs one argument — a handle of the object. But as long as the proper value is already in the stack, it is mindless to pop the value and then to push it again. So the source calls DeleteSomeObject without any arguments. The procedure knows the proper number of arguments (one in this example) and clean the stack properly.

The standard (and wrong) approach is to pop the argument from the stack and then to pass it to the procedure explicitly is the stdcall statement:

    stdcall  CreateSomeObject
    push     eax                ; save the handle.
    stdcall  DoSomething
    pop      eax                ; ??? Why ???
    stdcall  DeleteSomeObject, eax

This source will generate the meaningless instructions sequence:

    pop      eax
    push     eax

invoke macro is the same as "stdcall" with the only difference - it calls the procedure indirectly ( call [proc] instead of call proc ). This mechanism usualy is used to call the functions imported from external dynamic linked libraries. Of course, the imported functions can be call with stdcall [someproc] but the invoke macro helps to better distinguish what procedures are imported and what are internal for the program.

NOTE: The user should never use invoke in the portable programs, because such programs never use directly OS dependent import functions.

ccall macro calls a procedure with CCALL convention. This means that the procedure returns with simple "retn", without cleaning the parameters from the stack. Then "ccall" macro provides instructions that remove the arguments from the stack.

Because ccall have to know the exact count of passed arguments, all arguments have to be passed explicitly as a values in the ccall statement. Tricks as described above will not work properly and leads to stack not properly cleaned after the call.

"cinvoke" is the same as ccall, but using indirect call. The reason for existing of "cinvoke" macro is the same as with "invoke" macro — better legibility of the source.

About the calling conventions: While all Win32 dynamic linked libraries uses STDCALL convention, most (if not all) of Linux libraries uses CCALL convention. All code libraries of Fresh use STDCALL calling convention and it is platform independient.

11.1.3. Procedure call arguments

The arguments of the procedure call macros can be of two types:

32bit number - it can be numeric constant, register or memory location that is directly pushed to the stack. String - if the argument is string constant longer than 4 characters (the shorter strings are treated as a number) a string constant is created in the memory and the address of this constant is pushed to the stack. The string constant can contains more than one element enclosed in < and > brackets. See how text macro works.

Several examples of how some cases are compiled:

  stdcall MyProc, 1234h   

       > pushd 1234h

stdcall MyProc, 'shrt'  ; push it as a dword const.

       > pushd 'shrt'

stdcall MyProc, <'Some long text with control symbols', 13, 10>

       > local lbl
       > lbl text 'Some long text with control symbols', 13, 10
       > pushd lbl

stdcall MyProc, <'sh', 'rt'>   ; separate the short string on several pieces

       > local lbl
       > lbl text 'sh', 'rt'
       > pushd lbl

stdcall MyProc, txt 'shrt'   ; using "txt" prefix on short strings.

       > local lbl
       > lbl text 'shrt'
       > pushd lbl

stdcall MyProc, 'Long string'  

       > local lbl1
       > lbl1 text 'Long string'
       > pushd lbl1

If the same string is used several times, only one copy of the string is defined in the memory.

stdcall MyProc, 'Long string'

       > local lbl2
       > lbl2 text 'Long string'  ; lbl2 = lbl1
       > pushd lbl2

This functionality is provided by the macro pushx. It can be used by the user as well.

11.2. "_globals.inc" library

This library defines several macros intended to deal with data definitions.

Usually all data definitions have to be placed in special section of the executable file. This is not very convenient, because the code that process this data and the data definitions must reside in separate places of the source code, and in most cases even in different files.

The idea of "globals.inc" macro library is to allow the data definition to be described anywhere in the source code, but these definitions to be defined at once, at the place the programmer wants - usually in the data section of the program.

macro uglobal macro iglobal macro endg macro IncludeAllGlobals

uglobal begins block for undefined data definition. The block ends with endg macro. Between "uglobal" and "endg" macro any count of data definitions can be inserted.

Note that because uglobal block defines undefined data, it is only the labels and the size of data that have meaning inside this block. Any data, defined with data definition directive will not increase the size of the executable file, but will be allocated when the executable is loaded in the memory.

The undefined data will be defined later at the place where "IncludeAllGlobals" macro resides. In order to not increase the size of the executable file, the undefined data is always placed at the end of all data definitions.

"iglobal" macro, again combined with "endg" defines initialized data. The data defined in the block will be created at "IncludeAllGlobals" statement.

This block increases the size of the executable file, because it contains sensible data, that have to be included in the file.

Actually, neither uglobal, nor iglobal blocks defines any data immediately. Instead, the data definitions are stored in a list. The real definition occurs later, when IncludeAllGlobals macro is invoked. For this reason, IncludeAllGlobals must be placed in the source after all used global data blocks.

The programmer should not use explicitly IncludeAllGlobals, unless the memory model "manual" is set in the @BinaryType statement.

struc text [val]

The macro "text" is actually a structure. It needs to be preceded by some label name.

This macro accepts string or number arguments. When it is invoked with string arguments, it defines a zero terminated string constant, and also a local constant .length equal to the length of the string without terminating zero. When invoked with number as argument, "text" defines label at the address val and does not defines .length constant.

The "text" macro, the same way as iglobal and uglobal, simply stores string data for defer definition. This definition, occurs in IncludeAllGlobals invocation. Note that the real definition will be made only if the string is used in the program. Not used strings will not be defined.

Look at the following example:

        myName text 'John',$20,'Smith' 

This code will define the data and constant labels following way:

        if used myName
          myName db 'John Smith'
          .length = $-myName
                 db 0
        end if

Why to define separate macro for the strings and not to use the normal iglobal block? At first, text macro defines a real data only if this data is used somewhere in the source. This way is prevented bloating of the code with unneeded data definitions.

Also ( IMPORTANT ) the macro text defines only one instance of given string. For example, following code will define the string "TestTextMacro" only once and will set String2 to point to the same address as String1:

  String1 text "TestTextMacro"
  String2 text "TestTextMacro"

If the program changes the text on String1 the text on String2 will be changed as well, because they actually share the same memory.

This behavior of text macro made possible to FreshLib to allow using string constants directly as a procedure call arguments. As long as the duplication of the strings is not possible, using string constants as a procedure arguments will not cause duplication of data in the program memory.

macro var expr

The macro var defines dword variable with a given value. The use is following:

        var MyVar = 1234

The only differens from the usual use of dd directive is that the variable will be defined only if used in the source.

Note that the variable is created at the place where var is used, so you need to place it inside a iglobal block if you want it to be defined in the global data place.

11.3. "_struct.inc" library

This library contains only three simple macros:

macro struct name macro rstruct name ends

struct macro is aimed to provide easy creation of data structures. The "struc" directive in FASM is known to not create actual labels, but only the template for the label definitions. So, we need to create an instance of the data structure in order to have addresses and offsets of its fields.

But very often we don't have static data structure of the given type, but data structure, pointed by some of the registers. In this case in order to use offsets to the fields of the data structure, we need to define at least one virtual instance of the structure at address 0. Then we can use the values of the fields as an offsets in the instructions - for example:

    mov eax, [esi+RECT.right].

So, this is exactly what "struct" macro does. Besides it defines the "struc" structure with the given fields, it creates a single virtual instance of this structure, in order to be used later for register addressing. Also, the macro defines local constant of sizeof. global label equal to the byte size of the structure. In all remaining functionality it behaves exactly as the struc directive.

The syntax of struct macro is the following:

    struct StructureName
      .field1 dd ?
      .field2 RECT
      .fieldN:
    ends

The definition begins with "struct" followed by the structure name. The definition ends with "ends" directive. Between both, any local label definition becomes a member of the structure. The above definition, results in following code:

struc StructureName {
      .field1 dd ?
      .field2 RECT
      .fieldN:
    }
    virtual at 0
      StructureName StructureName
      sizeof.StructureName = $
    end virtual

The rstruct macro works exactly as struct but places the fields in reverse direction. I.e. the last field will have offset 0 and the first field will have smallest negative offset.

For example:

rstruct RevStruct
  .first dd ?         ; RevStruct.first = -8
  .second dd ?        ; RevStruct.second = -4
  label .last dword   ; RevStruct.last = 0
ends

This macro is useful for some variable data structures where the data is placed at the positive offsets and the header is located on the negative addresses.

FreshLib uses such structures in StrLib and some other libraries.

11.4. "_display.inc" library

This library contains macros that enhance the functionality of standard FASM "display" directive.

macro disp [arg]

The macro "disp" displays the strings given in the arguments, just as "display" FASM directive does. Additionally it can display numbers in any given radix:

    disp <number, radix>

macro DispSize Text, Sz

"DispSize" is very specialized macro, that displays the text and number in the following form:

Size of [Text] is: Sz bytes

The size number is automatically scaled to bytes or kbytes, depending on the value of Sz.

This macro allows easy display and control of the sizes of particular areas of the program - data structures, subroutines etc.

DispSize macro behavior is controlled by options.ShowSizes option.

How Fresh implements "display" directive

There are some specifics in Fresh IDE, concerning message displaying. The "display" directive in Fresh works in a slightly different way than the original FASM directive.

It outputs text in Fresh message window. Each message can have one of six icons, or it can have no icon at all. And because message window is implemented as a TreeView control, you can organize your messages into groups (directories).

Implementation is a bit "tricky" - when you display a character whose code is less than 16, it is interpreted in a special way. Characters from 1 to 6 set an icon of current message. It sounds complicated, but it is quite simple. Try:

    display 2, "some message"

It will display "some message" with an error icon. Another codes are used for controlling directory structure. Try to type following lines and see what would happen:

    display 3, "message at root", 0x09
    display 3, "child message1", 0x0a
    display 3, "child message2", 0x0d
    display 3, "again at root", 0x0a

Of course you don't have to put each message in separate display directive, you can, with the same result write:

display 3, "at root",$09,3,"child1",$0a,3,"child2", $0d,3,"again at root",$0a

Here is the complete list of all special characters and their meanings:

char 	meaning
$01 	set current icon to "warning" 	
$02 	set current icon to "error" 	
$03 	set current icon to "info" 	
$04 	set current icon to "find" 	
$05 	set current icon to "none" 	
$06 	set current icon to "debug" 	
$08 	end current row and set one level back. 	
$09 	end current row and set it as new directory. 	
$0a 	end current row and keep current level. 	
$0d 	end current row and set current level to root level. 	

12. FreshLib directory "system/"

12.1. "memory.asm" library

This library provides OS independent way of allocating, reallocating and freeing dynamic memory blocks. All other libraries in FreshLib that needs dynamic memory, use this library.

The user who needs such memory blocks should use it as well.

proc GetMem, .size

Allocates .size byte of dynamic memory.

Returns:

CF=0; EAX = pointer to the allocated memory; CF=1; EAX=0 if the memory can not be allocated.

The memory is filled with NULL.

proc FreeMem, .ptr

Frees the specified in [.ptr] dynamically allocated memory. Returns nothing.

proc ResizeMem, .ptr, .newsize

Reallocates memory on address [.ptr] to the new size in [.newsize]

Returns:

CF=0; EAX = pointer to the allocated memory; CF=1; EAX=.ptr if the memory can not be reallocated. In this case, the memory block is not changed

The increased part of the memory block is not zeroed.

12.2. "files.asm" library

proc FileOpen, .filename

The procedure opens the file with filename in [.filename] for reading.

Returns:

CF=0; EAX = Handle to the file.

CF=1; EAX = Error code.

proc FileCreate, .filename

Creates a file or opens the existing one and truncates its size to 0. The file is opened for writing.

Returns:

CF=0; EAX = Handle to the file.

CF=1; EAX = Error code.

proc FileClose, .handle

Closes the previously opened file.

Returns:

CF=0; EAX = Handle to the file. CF=1; EAX = Error code.

proc FileRead, .handle, .buffer, .count

Reads [.count] bytes from the file [.handle] in the buffer at [.buffer].

Returns:

CF=0; EAX = The count of actually read bytes.

CF=1; EAX = Error code.

proc FileWrite, .handle, .buffer, .count

Writes [.count] bytes from the buffer [.buffer] to the file with handle [.handle].

Returns:

CF=0; EAX = The count of actually written bytes.

CF=1; EAX = Error code.

proc FileSeek, .handle, .dist, .direction

Moves the file pointer of the file [.handle] on [.dist] distance (in bytes) relative to [.direction].

Direction is one of the following values:

fsFromBegin — relative to the file begin.

fsFromEnd — relative to the file end (then [.dist] should be negative).

fsFromCurrent — relative to the current position.

proc FileDelete, .filename

Deletes the file with filename in [.filename]

Returns:

CF=0; The file was deleted.

CF=1; EAX = Error code.

proc GetErrorString, .code

Returns in EAX, pointer to the human readable error message, corresponding to the error code passed in [.code]

The message string have to be passed to FreeErrorString, when not needed.

proc FreeErrorString, .ptrString

Frees the error string [.ptrString], previously returned by GetErrorString. As long as the error strings are allocated by the OS, they have to be free by OS as well. Returns nothing.

proc LoadBinaryFile, .ptrFileName

Loads the whole file [.ptrFileName] to the dynamically allocated memory block.

Returns:

CF=0; EAX = pointer to the allocated memory; ECX = the size of the loaded file.

CF=1; EAX = Error code. ECX = 0; The memory is not allocated.

The allocated memory have to be free after use with FreeMem.

proc SaveBinaryFile, .ptrFileName, .aptr, .size

Creates or overwrites the file [.ptrFileName] with the [.size] bytes from the buffer [.aptr];

Returns:

CF=0; EAX = count of the bytes actually write;

CF=1; EAX = error code;

proc FileExists, .ptrFileName

Check the existence of the file with name in [.ptrFileName].

Returnds:

CF=1 — the file does not exists.

CF=0 — the file exists.

The existence of the file is checked using FileOpen procedure. If the file can be opened, it is considered existing.

12.3. "process.asm" library

proc Terminate, .exit_code

Terminates the application and all of its threads. Returns [.exit_code] to the OS.

This procedure simply does not returns, because the application stops.

proc ThreadCreate, .ptr_to_function, .ptr_to_args

Creates new thread. [.ptr_to_function] points to the thread procedure. The thread procedure should have one argument. When the thread starts, [.ptr_to_args] is passed as a thread argument.

Returns:

CF=0; EAX = is a handle to the new thread. In the different OSes this value can have different meaning. But it identifies the thread anyway.

CF=1; EAX = error code;

proc MutexCreate, .ptrName, .ptrMutex

Creates new mutex with name [.ptrName] and save its handle to [.ptrMutex] variable.

The calling thread takes the owneship of the mutex.

If [.ptrName] = 0, unnamed mutex will be created.

proc WaitForMutex, .ptrMutex, .timeout

Waits until the mutex is released and takes the ownership.

Returns:

CF=0 — the mutex ownership is successfuly obtained. CF=1 — the timeout was expired.

proc MutexRelease, .ptrMutex

Releases the ownership of the specified mutex.

proc MutexDestroy, .ptrMutex

Destroys the mutex [.ptrMutex]

12.4. "clipboard.asm" library

clipboard.asm library contains very simple clipboard functions that works only on text data.

proc ClipboardRead

Returns in EAX handle to the string with the current clipboard content. If the clipboard is empty or contains not textual information, EAX=0; The user should delete the string when not needed by passing it to StrDel.

proc ClipboardWrite, .hstring

Writes the string [.hstring] to the clipboard. Returns nothing.

13. FreshLib directory "timers/"

13.1. "timers.asm" library

library deals with user created timers and also contains some procedures for work with the system time and date.

TTimer structure.

The timers in FreshLib are represented with the following memory structure:

    struct TTimer
      .next dd ?

      .interval dd ?
      .value    dd ?


      .flags    dd ?
      .Callback dd ?
      .Expired  dd ?
      .tag      dd ?
    ends

The fields are:

.next — Don't change this. It is a pointer to the next timer in the timers chain. It is for internal use only.

.interval — the interval of the time in ms

.value — The current value of the timer in ms. When this value becomes higher than [.interval] an event is fired and the value becomes 0. This value is incremented by the system dependent time step - probably something like 1..100ms

.flags — contains a set of tmfXXXX flag values. Determines the behavior of the timer. See below for description of the flags.

.Callback — pointer to the callback procedure of the timer. The callback procedure should accept one argument with the pointer to the timer that fired the event: proc OnTimer, .ptrTimer

.Expired — count of the timer expirations, if the callback procedure was not called.

.tag — user defined value associated with the timer.

The .flags field can have one or more of the following values:

tmfDoNothing — when the timer expires no action should be performed. .Expired field of the timer will be incremented.

tmfCallProc — [TTimer.Callback] contains pointer to the procedure that to be executed once per timer expiration.

tmfSyncDestroy — If this flag is set, the timer will be destroyed on the next timer expiration. In this case, the configured event is fired and then the timer is destroyed. The flag is checked after the event returns, so the event handler can reset this flag and thus to prevent destruction.

tmfRunning — If this flag is set, the timer runs. If the event handler resets this flag, the timer will fire only once and will be suspended.

proc TimerCreate

Creates a new timer.

Returns:

CF=0; EAX= pointer to the TTimer structure. The timer is created suspended. The user can set or reset tmfRunning in [.flags] in order to start or stop the timer. Also, the user have to enter proper values in the remaining fields.

CF=1; Error allocating memory.

proc TimerDestroy, .ptrTimer

Destroys the timer [.ptrTimer]

14. FreshLib directory "simpledebug/"

14.1. "debug.asm" library

This library includes number or macros and procedures aimed to assist the debugging process of the application. These macros display different data values on the debugging console.

The library contains its own output procedures, so it does not depend on the other used libraries.

All the macros from this library generate code only when options.DebugMode = 1, so the programmer can include as many debug statements as needed and leave them in the source. They will not be included in the final binary. The debug macros will always preserve all registers, except the EFLAGS register.

macro DebugMsg msg

Displays the text message msg to the debug console. Example:

     DebugMsg 'The program executes here!'

macro OutputRegister reg, radix

Outputs the content of some register in the given radix. Example:

    OutputRegister regEAX, 10

The possible register values are: regEDI, regESI, regEBP, regESP, regEBX, regEDX, regECX, regEAX

macro OutputMemory pointer, size

OutputMemory will dump [size] bytes of memory at address [pointer]; Example:

    OutputMemory esi, 128

macro OutputNumber number, radix, digits

Outputs digits digits of the number in radix radix. Example:

    OutputNumber 12345, 16, 8

proc GetTimestamp

Returns in eax timestamp measured in milliseconds (ms).

15. FreshLib directory "data/"

This directory contains several libraries that handles different data structures. The libraries are mostly OS independent. Actually the only OS dependent part is one small routine in Win32 section, that converts strings from UTF-8 to UTF-16 because Windows can't handle UTF-8 strings directly.

15.1. "arrays.asm" library

This library handles dynamic arrays, containing elements of arbitrary size. All elements of the array have the same size.

TArray structure have following definition:

    struct TArray
      .count     dd ?
      .capacity  dd ?
      .itemsize  dd ?
      .lparam    dd ?
      label .array dword
    ends

The above structure represents the header of the array. The actual array will have arbitrary size, depending on the element count and size.

The first element of the array begins on offset TArray.array from the begining of the memory block.

The field TArray.count contains the current element count of the array.

The field TArray.capacity contains the current capacity of the array. It is because the library usually allocates more memory than is needed for the array element count. This approach reduces memory allocations and reallocations and thus increases the speed of inserting and deleting elements in the array. How many memory will be allocated depends on the user setting of the variable ResizeIt (defined in memory.asm). This variable contains a pointer to the procedure that simply increases the value of ECX to the next suitable value.

The field TArray.itemsize contains the size in bytes of one array element. Changing of this value is not recommended.

The field TArray.lparam is for user defined parameter, associated with the array.

proc CreateArray, .itemSize

This procedure creates new array with item size [.ItemSize]

The procedure returns CF=0 if the array is properly created and pointer to the array is placed in EAX.

In case the memory cannot be allocated, the procedure returns CF=1. To free the allocated array, use FreeMem procedure.

proc AddArrayItems, .ptrArray, .count

This procedure adds new array items at the end of the array pointed by [.ptrArray]

The procedure returns two values:

EAX contains pointer to the first of the new appended elements.

EDX contains pointer to the array (in the process of appending of the new element, it is possible the whole array to be moved to the new address in memory, so the programmer should store the value of EDX for the future reference to the array.

In case, the new memory can not be allocated, the procedure returns CF=1 and EDX contains the proper pointer to the original array.

proc InsertArrayItems, .ptrArray, .iElement, .count

This procedure inserts [.count] new elements at the [.iElement] position of the array pointed by [.ptrArray]

If [.iElement] is larger or equal to [TArray.count] the elements are appended at the end of the array. (Just like AddArrayItems) Otherwise, all elements are moved to make room for the new elements.

The procedure returns exactly the same results as AddArrayItems procedure — EDX points to the array and EAX points to the first of the new inserted elements.

CF is an error flag.

proc GetArrayItem, .array, .item

CF=0; Returns in EAX pointer to the array item with index [.item].

CF=1; The requested item does not exists ( [.item] >= [.array.count] ). In this case, EAX contains pointer to the end of the array the byte next after the last array element.

proc DeleteArrayItems, .ptrArray, .iElement, .count

This procedure deletes [.count] items with begin index [.iElement] the [.ptrArray] dynamic array. If the capacity of the array is bigger than the recommended for the new count, then the array is resized. The recommended size is calculated using ResizeIt procedure from memory library.

Returns EDX - pointer to the TArray. In the most cases this pointer will not be changed, but this also depends on the current OS memory allocation API, so it is safer to store the pointer for future use, instead of one passed to the procedure.

This procedure can not fail, because deleting element is always possible. In some rare cases it can fail to reallocate smaller memory block, but this is not a problem for the array consistency.

proc VacuumArray, .ptrArray

This procedure removes the reserved memory from the array in order to make it as small as possible. Note, that the first insert/append operation after the vacuum operation will be very slow. The memory economized this way depends on reallocation strategy and can be from 25 to 100% in some cases.

proc ListIndexOf, .ptrList, .Item

The list is a special case of array with item size equal to 4 bytes (dword). This procedure searches the list [.ptrList] for item equal to [.Item] and returns the index of the element in EAX. In case of error CF=1.

proc ListFree, .ptrList, .FreeProc

Frees all elements of the list [.ptrList], calling [.FreeProc] for every element of the list.

FreeProc callback procedure have one argument of type dword that is the value of the current list element. The definition of the callback procedure is similar to following:

    proc FreeMyListItem, .ptrItem
    begin
            ;do something with the item being freed
            return
    endp

15.2. "strlib.asm" library

Using strings in assembler was often problematic for programmers - static strings can't be resized, so they had to reserve as many bytes as they thought user could need, and it still could be not enough. For that reason we created Dynamic String Library - a library that operates on dynamic strings, that are automatically resized when needed. Also, StrLib contains many functions that perform different string operations — comparison, inserting one string into another, etc. In StrLib, the strings are represented by handles, not by pointers. This way, the string can be freely resized and moved in memory. StrLib can distinguish the handle values from pointer and will process properly both of them. When the processing is possible, the procedures will operate on static strings in memory.

The strings in the StrLib are stored in specific format. The format is defined following way:

    struc string {
      .capacity dd ?
      .len      dd ?
      label .data byte
    }

    virtual at -(sizeof.string)
      string string
      sizeof.string = $-string
    end virtual

The structure string have variable length and is dynamically allocated.

The field string.capacity on offset 8* contains the allocated memory size in bytes.

The field string.len on offset 4* contains the current length of the string in bytes.

The string content begins on offset 0. The content of the string always ends with at least one zero byte, so the string format is compatible with ASCIIZ format used in the most OS API.

All procedures in StrLib will set [string.len] to the proper value and will use it in the string processing.

If the programmer manipulates the string data directly, he should set [string.len] himself, or call StrFixLen in order to let StrLib to scan the string and to fix the length field.

StrLib procedure reference:

        proc StrNew

Creates new dynamic string and returns its handle.

        proc StrDel, .hstring

Frees the memory occupied by given string. If the .hstring is pointer to memory, StrDel will try to find it in the table of created strings and if found, will free it as well. If the string passed by pointer is not found in the list - StrDel exits without error. Note, that passing pointer can degrade the performance of the procedure.

        proc StrPtr, .hstring

Returns in EAX the pointer of the string with handle [.hstring] If .hstring is pointer EAX will be equal to [.hstring] If the handle is invalid, StrPtr returns CF=1 and EAX=0.

        proc StrLen, .hstring

Returns the length of the string in bytes, excluding the terminating zero. If [.hstring] is handle, the procedure returns directly the stored length of the string. If [.hstring] is pointer, the functions scans the string and computes the length. Thus, passing handle is much faster, especially for long strings.

        proc StrDup, .hstring

Creates new string and copy the content of [.hstring] to it. Returns in EAX — handle of the new string. [.hstring] can be memory pointer or string handle.

        proc StrFixLen, .hstring

StrFixLen scans the string in order to compute its actual length and then writes this length in the field [string.len]. StrFixLen should be call only with handle of the string as argument. It will process pointer as well, but will assume there is a field [string.len] at offset -4. The user should call StrFixLen only if the [string.len] field does not contains the proper value, because of some reason - for example the user made some string processing that changes the length of the string or the string data is returned by some OS function that does not care about string length.

        proc StrSetCapacity, .hString, .capacity

This function ensures that the allocated for the string memory is enough to hold at least [.capacity] bytes. If needed the string memory is reallocated. Returns pointer to the string data in EAX. If the reallocation is impossible, returns CF=1;

    proc StrCopy, .dest, .source

Copies the content of [.source] string to [.dest] string. [.dest] must be a handle. [.source] can be handle or pointer. Returns nothing.

    proc StrCompCase, .str1, .str2
    proc StrCompNoCase, .str1, .str2

Compares two strings - case sensitive (StrCompCase) or string not sensitive (StrCompNoCase).

Returns CF = 1 if the strings are equal.

Returns CF = 0 if the strings are different.

The speed of this procedure varies depending on passed strings and its content. The worst case is when the strings are passed as pointers and have equal lengths. The best case is when the strings are passed as handles and have different lengths.

    proc StrCat, .dest, .source

Concatenates the string [.source] to the end of the string [.dest].

    proc StrCharPos, .hString, .char

StrCharPos returns a pointer to the first occurence of a given char in specified string.

    proc StrPos, .hstring, .hpattern

StrPos returns in EAX a pointer to the first occurence of a [.hpattern] string in [.hstring] or NULL if the pattern was not found.

    proc StrCopyPart, .dest, .source, .pos, .len

Extracts [.len] bytes on position [.pos] from the string [.source] and copies them to the string [.dest]. Returns CF=1 if the needed memory can not be allocated.

    proc StrExtract, .string, .pos, .len

Extracts [.len] bytes on position [.pos] from the string [.source] and copies them to the new created string. Returns the created string in EAX or CF=1 if the needed memory can not be allocated.

    proc StrSplit, .hString, .pos

Splits the string [.hstring] into two parts on byte possition [.pos]. The left part remains in [.hstring]; The right part is returned as new created string in EAX. Note that the memory of the [.hstring] will not be reallocated, only the length of the string will be set accordingly.

    proc StrInsert, .dest, .source, .pos

Inserts the [.source] string on possition [.pos] into the [.dest] string. Returns nothing.

    proc NumToStr, .num, .flags

Converts number [.num] in any radix to string. Returns the new created string in EAX.

[.flags] controls the way number have to be converted. .flags is dword value that contains following values:

byte0 - number of digits if ntsFixedWidth is specified.

byte1 - radix for the convertion. Some radixes have predefined constants:

    ntsBin  = $0200
    ntsQuad = $0400
    ntsOct  = $0800
    ntsDec  = $0a00
    ntsHex  = $1000

byte2, byte3 - flags:

    ntsSigned       = $00000
    ntsUnsigned     = $10000
    ntsFixedWidth   = $20000

    proc StrToNumEx, .hstring

Converts [.hstring] to number. Returns CF=0 and value in EAX if the conversion was successful, or CF=1 and EAX = 0 if not.

The procedure supports the FASM numbers format:

0x1111, $1111 or 1111h will be converted as HEX;

1111 as decimal;

1111b as binary;

1111o as octal.

    proc StrCharCat, .hString, .char

Appends up to 4 bytes from [.char] at the end of [.hString]

    proc StrCharInsert, .hString, .char, .pos

Inserts up to 4 characters from [.char] into the [.pos] position of the [.hString]

    proc StrClipSpacesR, .hString
    proc StrClipSpacesL, .hString

Removes the spaces from the start (StrClipSpacesL) or from the end (StrClipSpacesR) of the string [.hString].

    proc StrCleanDupSpaces, .hString

Removes duplicating spaces from the string [.hStrin] and leaves only single spaces. For example the string ("." represents the space char) "123.....456" will be processed to "123.456".

    proc StrHash, .hString

Computes the hash value from the string [.hString]. This procedure implements FNV-1b algorithm.

Returns 32 bit hash value in EAX.

    proc DataHash, .ptrData, .len

Computes the hash value from the memory array at address [.ptrData] with byte length [.len]. This procedure also uses FNV-1b algorithm.

Returns 32 bit hash value in EAX.

    proc StrLenUtf8, .hString, .len

Computes the length in chars of the first [.len] bytes of the UTF-8 encoded string [.hString] The scan of the string ends on one of the two conditions — terminating zero byte is reached or [.len] bytes are processed. So, if [.len] == -1 the scan will always end on the end of the string.

    proc StrOffsUtf8, .hString, .pos

Returns in EAX the address of the [.pos] character of the UTF-8 encoded string [.hString] If the length of the string is less than [.pos] — returns NULL.

    proc DecodeUtf8, .chars

Decodes 4 bytes in [.chars] to UNICODE dword value.

Returns: CF=0 — no error; eax — unicode value; edx — byte count of the char. [1..4]

CF=1 — invalid utf-8 char; if eax = edx = 0; the character can not be decoded; if edx <> 0 — eax = the overlong encoded character. edx = byte count of the char.

Note: When CF=1 and [.chars] is overlong encoded char, eax contains the proper value and edx contains the proper length. But it is still invalid character, according to the standards.

    proc ExpandTabs, .hstring, .tabstop

Converts the tab characters in [.hstring] into space characters, according to [.tabstop] length. Returns in EAX a value, that indicates by how many chars the length of the string increased.