pigmeo-compiler : Pigmeo.Compiler Namespace

config.Internal Class

Configuration of the compiler itself

public class config.Internal


Remarks

To be added.

Members

See Also: Inherited members from object.

Constructors

Static constructor. It loads the default parameters

Fields

AddCommentsToAsm
static
bool . Indicates if comments should be added to generated assembly language code
AppName
const
string . Name of this application
AppVersion
const
string . Version of this application
AssemblyName
static
string . Internal name given to the generated bundle assembly
CompilationConfigFile
static
string . Path to the file which contains all the compilation-related settings
CompilerLicense
const
string . To be added.
Developers
const
string . The list of developers
EndOfLine
static
string . Char or string which is going to be used as line ending in text files (such as assembly language apps)
FileAsm
static
string . Path to the file where the compiled application to assembly language will be saved
FileBundle
static
string . Path to the file where the bundled assembly will be saved
FileBundleOptimized
static
string . Path to the file where the optimized bundled assembly will be saved
FileError
static
string . Path to the file where all the errors are printed to
FileSummary
static
string . Path to the file where a summary of the compilation will be printed to
FileSymbolTable
static
string . Path to the symbols table file
FrameworkLicense
const
string . To be added.
GenerateAsmFile
static
bool . Indicates if the generated source code in assembly language should be written to a file
GenerateErrorFile
static
bool . Indicates if the error file should be generated
GenerateSummaryFile
static
bool . Indicates if a file containing a summary about the compilation should be generated
GenerateSymbolTableFile
static
bool . Indicates if a file containing the symbol table should be generated
GlobalNamespace
static
string . Name of the namespace within the bundle which will contain everything
GlobalStaticThings
static
string . Name of the class where everything static (methos, variables...) will be stored
MainModuleName
static
string . Internal name given to the main module of the generated bundle assembly
NumeralSystem
static
NumeralSystems . The numeral system used for representing numbers in generated assembly language code
PigmeoConfigPath
static
string . Path to the directory where all the settings related to pigmeo are stored
PrjDomain
const
string . Domain of this project
PrjName
const
string . Name of this project
SaveBundle
static
bool . Indicates if the bundled assembly should be saved to disk
SizeIconPanelButtons
const
ushort (36). Width and height of the icons placed inside the big buttons on the left
SizeIconSmallButtons
const
ushort (17). The size of the image placed inside those buttons that only contain an icon, not text
UI
static
UserInterface . User Interface configured for this instance of the compiler
UserApp
static
string . Path to the .exe file, the application written by the user which is being compiled
Verbosity
static
VerbosityLevel . If verbose==true some more information will be shown to the user If debug==true LOTS of stuff will be shown to the user Available verbosity levels (the amount of messages printed to the user)

Properties

CompilerConfigFile [read-only]
static
string . Path to the file which contains all the compiler-related settings
ExeLocation [read-only]
static
string . Full path to the directory that contains the Pigmeo Compiler executable file. The last character is NOT a slash ('/')
ExePath [read-only]
static
string . Full path to the Pigmeo Compiler executable file
GlobalStaticThingsFullName [read-only]
static
string . To be added.
ImagesDirectory [read-only]
static
string . Full path to the directory that contains all the required images for the graphical interfaces. The last character is NOT a slash ('/')
lang
static
string . Language used for showing messages
PrjWebsite [read-only]
static
string . Website of this project
WorkingDirectory
static
string . To be added.

Methods

static ReadCompilerConfigFile ()
Loads the configuration of the compiler itself, not the compilation-related settings
static SaveCompilerConfigFile ()
Saves the configuration of the compiler itself, not the compilation-related settings

Member Details

config.Internal Constructor

public config.Internal ()

Static constructor. It loads the default parameters

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

AddCommentsToAsm Field

public static bool AddCommentsToAsm

Indicates if comments should be added to generated assembly language code

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

AppName Field

public const string AppName

Name of this application

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

AppVersion Field

public const string AppVersion

Version of this application

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

AssemblyName Field

public static string AssemblyName

Internal name given to the generated bundle assembly

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

CompilationConfigFile Field

public static string CompilationConfigFile

Path to the file which contains all the compilation-related settings

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

CompilerConfigFile Property

public static string CompilerConfigFile { get; }

Path to the file which contains all the compiler-related settings

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

CompilerLicense Field

public const string CompilerLicense

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

Developers Field

public const string Developers

The list of developers

Remarks

When using this variable, make sure you replace "\n" by the correct line ending, which by default is configured at config.Internal.EndOfLine but it really depends on where it is going to be shown

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

EndOfLine Field

public static string EndOfLine

Char or string which is going to be used as line ending in text files (such as assembly language apps)

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

ExeLocation Property

public static string ExeLocation { get; }

Full path to the directory that contains the Pigmeo Compiler executable file. The last character is NOT a slash ('/')

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

ExePath Property

public static string ExePath { get; }

Full path to the Pigmeo Compiler executable file

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

FileAsm Field

public static string FileAsm

Path to the file where the compiled application to assembly language will be saved

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

FileBundle Field

public static string FileBundle

Path to the file where the bundled assembly will be saved

Remarks

The bundled assembly is the executable file which contains all the code chunks required for running the app, so it doesn't contain any dependencies/references

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

FileBundleOptimized Field

public static string FileBundleOptimized

Path to the file where the optimized bundled assembly will be saved

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

FileError Field

public static string FileError

Path to the file where all the errors are printed to

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

FileSummary Field

public static string FileSummary

Path to the file where a summary of the compilation will be printed to

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

FileSymbolTable Field

public static string FileSymbolTable

Path to the symbols table file

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

FrameworkLicense Field

public const string FrameworkLicense

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

GenerateAsmFile Field

public static bool GenerateAsmFile

Indicates if the generated source code in assembly language should be written to a file

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

GenerateErrorFile Field

public static bool GenerateErrorFile

Indicates if the error file should be generated

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

GenerateSummaryFile Field

public static bool GenerateSummaryFile

Indicates if a file containing a summary about the compilation should be generated

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

GenerateSymbolTableFile Field

public static bool GenerateSymbolTableFile

Indicates if a file containing the symbol table should be generated

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

GlobalNamespace Field

public static string GlobalNamespace

Name of the namespace within the bundle which will contain everything

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

GlobalStaticThings Field

public static string GlobalStaticThings

Name of the class where everything static (methos, variables...) will be stored

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

GlobalStaticThingsFullName Property

public static string GlobalStaticThingsFullName { get; }

To be added.

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

ImagesDirectory Property

public static string ImagesDirectory { get; }

Full path to the directory that contains all the required images for the graphical interfaces. The last character is NOT a slash ('/')

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

lang Property

public static string lang { set; get; }

Language used for showing messages

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

MainModuleName Field

public static string MainModuleName

Internal name given to the main module of the generated bundle assembly

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

NumeralSystem Field

public static NumeralSystems NumeralSystem

The numeral system used for representing numbers in generated assembly language code

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

PigmeoConfigPath Field

public static string PigmeoConfigPath

Path to the directory where all the settings related to pigmeo are stored

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

PrjDomain Field

public const string PrjDomain

Domain of this project

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

PrjName Field

public const string PrjName

Name of this project

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

PrjWebsite Property

public static string PrjWebsite { get; }

Website of this project

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

ReadCompilerConfigFile Method

public static void ReadCompilerConfigFile ()

Loads the configuration of the compiler itself, not the compilation-related settings

Attributes:Pigmeo.Internal.PigmeoToDo("Unimplemented")

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

SaveBundle Field

public static bool SaveBundle

Indicates if the bundled assembly should be saved to disk

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

SaveCompilerConfigFile Method

public static void SaveCompilerConfigFile ()

Saves the configuration of the compiler itself, not the compilation-related settings

Attributes:Pigmeo.Internal.PigmeoToDo("Unimplemented")

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

SizeIconPanelButtons Field

public const ushort SizeIconPanelButtons

Value: 36

Width and height of the icons placed inside the big buttons on the left

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

SizeIconSmallButtons Field

public const ushort SizeIconSmallButtons

Value: 17

The size of the image placed inside those buttons that only contain an icon, not text

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

UI Field

public static UserInterface UI

User Interface configured for this instance of the compiler

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

UserApp Field

public static string UserApp

Path to the .exe file, the application written by the user which is being compiled

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

Verbosity Field

public static VerbosityLevel Verbosity

If verbose==true some more information will be shown to the user If debug==true LOTS of stuff will be shown to the user Available verbosity levels (the amount of messages printed to the user)

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0

WorkingDirectory Property

public static string WorkingDirectory { set; get; }

To be added.

Value

To be added.

Remarks

To be added.

Required Assembly Versions:

  • pigmeo-compiler 0.0.0.0