XSharp Bandol

Bandol GA (2.0.6.0)

© 2015- 2019 XSharp BV

 1 XSharp Bandol

Table of Contents
Foreword 0

Part I X# Documentation 8
1 Getting
...................................................................................................................................
Started with X# 10
Version History ...........................................................................................................................................10
Dialects ...........................................................................................................................................77
Bring Your Ow n Runtim ...........................................................................................................................................80
e (BYOR)
Know n Issues ...........................................................................................................................................81
Installation ...........................................................................................................................................81
New language features ...........................................................................................................................................83
Anonymous Methods...................................................................................................................................86
Anonymous Types ...................................................................................................................................87
ASTYPE ...................................................................................................................................89
ASYNC - AWAIT ...................................................................................................................................89
BEGIN CHECKED ...................................................................................................................................90
BEGIN FIXED ...................................................................................................................................91
BEGIN UNCHECKED ...................................................................................................................................91
BEGIN UNSAFE ...................................................................................................................................92
BEGIN USING ...................................................................................................................................92
Collection Initializers ...................................................................................................................................93
Conditional Access Expression
...................................................................................................................................94
Creating Generic Classes ...................................................................................................................................95
DEFAULT Expressions ...................................................................................................................................96
EVENT (Add and Remove) ...................................................................................................................................97
Expression IS Type...................................................................................................................................100
Initializers ...................................................................................................................................101
Interpolated Strings ...................................................................................................................................102
LINQ Query Expressions ...................................................................................................................................103
NOP ...................................................................................................................................105
Object Initializers ...................................................................................................................................105
SWITCH ...................................................................................................................................106
USING ...................................................................................................................................107
VAR ...................................................................................................................................108
YIELD ...................................................................................................................................108
XBase++ class declarations
...................................................................................................................................109
Licensing ...........................................................................................................................................111
XSharp Open Softw...................................................................................................................................113
are License
Apache 2 ...................................................................................................................................117
BSD ...................................................................................................................................121
XSharp Compiler Sourcecode
...................................................................................................................................122
License
Acknow ledgem ents ...........................................................................................................................................127
Who is w ho in the...........................................................................................................................................128
X# team
2 Migrating
...................................................................................................................................
apps from VO to X# 129
Exam ple 1: The VO...........................................................................................................................................129
Explorer Exam ple
Exam ple 2: The VOPAD
...........................................................................................................................................136
Exam ple
Exam ple 3: The Pizza
...........................................................................................................................................139
Exam ple
Exam ple 4: Ole Autom
...........................................................................................................................................140
ation - Excel
Exam ple 5: OCX - ...........................................................................................................................................145
The Em ail Client Exam ple
3 The
...................................................................................................................................
X# Runtime 150
XSharp.Core ...........................................................................................................................................154
XSharp.RT ...........................................................................................................................................154
XSharp.VO ...........................................................................................................................................155
XSharp.XPP ...........................................................................................................................................155

© 2015- 2019 XSharp BV

 Contents 2

XSharp.VFP ...........................................................................................................................................155
XSharp.Macrocom ...........................................................................................................................................156
piler
XSharp.Macrocom ...........................................................................................................................................156
piler.Full.DLL
XSharp.RDD ...........................................................................................................................................157
Installation in the...........................................................................................................................................158
GAC
XBase Types ...........................................................................................................................................158
Array Of Type ...................................................................................................................................159
Array Type ...................................................................................................................................161
CodeBlock ...................................................................................................................................161
Date Type ...................................................................................................................................161
Float Type ...................................................................................................................................161
Logic Ttype ...................................................................................................................................161
PSZ Type ...................................................................................................................................162
Symbol Type ...................................................................................................................................162
Usual Type ...................................................................................................................................162
4 X#
...................................................................................................................................
Scripting 163
5 Using
...................................................................................................................................
X# in Visual Studio 168
Project System ...........................................................................................................................................168
Source code Items ...................................................................................................................................168
Forms ...................................................................................................................................168
Other Item types ...................................................................................................................................168
Project Properties ...................................................................................................................................168
Resources ...................................................................................................................................168
Settings ...................................................................................................................................168
Source Code Editor ...........................................................................................................................................168
Keyw ord Coloring ...................................................................................................................................169
Highlighting Errors ...................................................................................................................................169
Regions ...................................................................................................................................169
Blocks ...................................................................................................................................169
Parameter Tips ...................................................................................................................................169
Quick Info ...................................................................................................................................169
Code Completion ...................................................................................................................................169
Tem plates ...........................................................................................................................................169
Project Templates ...................................................................................................................................169
Item Templates ...................................................................................................................................171
Debugger ...........................................................................................................................................173
6 X#
...................................................................................................................................
Programming guide 173
Quick Start ...........................................................................................................................................173
Arrays ...........................................................................................................................................173
Classes and Structures
...........................................................................................................................................173
Codeblock, Lam bda
...........................................................................................................................................173
and Anonym ous Method Expressions
Delegates ...........................................................................................................................................175
Enum eration Types
...........................................................................................................................................175
Events ...........................................................................................................................................175
Exceptions and Exception
...........................................................................................................................................176
Handling
File System and the
...........................................................................................................................................176
Registry
Generics ...........................................................................................................................................176
Indexers ...........................................................................................................................................176
Interfaces ...........................................................................................................................................176
Interoperability ...........................................................................................................................................176
LINQ Query Expressions
...........................................................................................................................................176
Mem ory Variables...........................................................................................................................................176
Nam espaces ...........................................................................................................................................180
Nullable Types ...........................................................................................................................................180
Statem ents, Expressions
...........................................................................................................................................180
and Operators
Strings ...........................................................................................................................................180
Types ...........................................................................................................................................180

© 2015- 2019 XSharp BV

3 XSharp Bandol

Unsafe Code and...........................................................................................................................................181

Pointers
XML Docum entation
...........................................................................................................................................181
Com m ents
7 X#
...................................................................................................................................
Reference 181
X# Language Reference
...........................................................................................................................................181
X# Keyw ords ...................................................................................................................................181
Types ..........................................................................................................................201
Simple (Native) Types ......................................................................................................................202
BYTE ......................................................................................................................202
CHAR ......................................................................................................................203
DECIMAL ......................................................................................................................203
DWORD ......................................................................................................................203
DYNAMIC ......................................................................................................................203
INT ......................................................................................................................203
INT64 ......................................................................................................................203
LOGIC ......................................................................................................................204
OBJECT ......................................................................................................................204
PTR ......................................................................................................................204
REAL4 ......................................................................................................................204
REAL8 ......................................................................................................................204
SBYTE ......................................................................................................................205
SHORT ......................................................................................................................205
STRING ......................................................................................................................205
UINT64 ......................................................................................................................205
VOID ......................................................................................................................205
WORD ......................................................................................................................205
xBase Specific Types ......................................................................................................................205
ARRAY ......................................................................................................................205
CODEBLOCK ......................................................................................................................206
DATE ......................................................................................................................207
FLOAT ......................................................................................................................207
PSZ ......................................................................................................................207
SYMBOL ......................................................................................................................207
USUAL ......................................................................................................................208
User defined Types......................................................................................................................208
CLASS ......................................................................................................................209
CLASS (Xbase++ Syntax) ......................................................................................................................209
CLASS (VFP Syntax) ......................................................................................................................209
DELEGATE ......................................................................................................................209
ENUM ......................................................................................................................209
GLOBAL ......................................................................................................................209
INTERFACE ......................................................................................................................211
STRUCTURE ......................................................................................................................212
UNION ......................................................................................................................212
VOSTRUCT ......................................................................................................................212
Generic Types ......................................................................................................................212
Class Members ......................................................................................................................213
Constructor ......................................................................................................................213
Declare ......................................................................................................................213
Destructor ......................................................................................................................214
Event ......................................................................................................................214
Method ......................................................................................................................215
Operator ......................................................................................................................215
Property ......................................................................................................................216
ClassVars ......................................................................................................................217
Entities ..........................................................................................................................217
Namespace ......................................................................................................................218
Function ......................................................................................................................218
Procedure ......................................................................................................................218

© 2015- 2019 XSharp BV

 Contents 4

Using ......................................................................................................................219
Define ......................................................................................................................219
_DLL ......................................................................................................................220
Parameters and others ..........................................................................................................................220
Parameters ......................................................................................................................220
Attributes ......................................................................................................................221
Modifiers ......................................................................................................................221
Arguments ......................................................................................................................222
Array Indices ......................................................................................................................223
Statements ..........................................................................................................................223
?, ?? ......................................................................................................................226
ASYNC .. AWAIT ......................................................................................................................226
BEGIN (UN)CHECKED ......................................................................................................................226
BEGIN FIXED ......................................................................................................................226
BEGIN LOCK ......................................................................................................................226
BEGIN SCOPE ......................................................................................................................227
BEGIN SEQUENCE ......................................................................................................................227
BEGIN UNSAFE ......................................................................................................................227
BEGIN USING ......................................................................................................................227
BREAK ......................................................................................................................227
DO CASE ......................................................................................................................227
DO WHILE ......................................................................................................................229
EXIT ......................................................................................................................229
Expression Statement ......................................................................................................................229
FIELD ......................................................................................................................229
FOR ... NEXT ......................................................................................................................230
FOREACH ... NEXT......................................................................................................................230
IF ... ELSE ... ENDIF......................................................................................................................231
LOCAL ......................................................................................................................231
LOOP ......................................................................................................................235
MEMVAR ......................................................................................................................235
NOP ......................................................................................................................236
PARAMETERS ......................................................................................................................236
PRIVATE ......................................................................................................................237
PUBLIC ......................................................................................................................239
REPEAT ... UNTIL ......................................................................................................................241
RETURN ......................................................................................................................241
Statement Block ......................................................................................................................242
SWITCH ......................................................................................................................242
THROW ......................................................................................................................242
TRY ... CATCH ... ......................................................................................................................242
FINALLY
YIELD EXIT ......................................................................................................................242
YIELD RETURN ......................................................................................................................243
STATIC ......................................................................................................................243
Literals ..........................................................................................................................243
Char Literals ......................................................................................................................244
String Literals ......................................................................................................................245
Date Literals ......................................................................................................................246
Logic Literals ......................................................................................................................246
Null Literals ......................................................................................................................246
Numeric Literals ......................................................................................................................247
Integer Literals ......................................................................................................................248
Floating point Literals......................................................................................................................248
Symbol Literals ......................................................................................................................248
NameSpaces ..........................................................................................................................249
USING ......................................................................................................................249
BEGIN NAMESPACE ......................................................................................................................249
Identifiers ..........................................................................................................................249

© 2015- 2019 XSharp BV

5 XSharp Bandol

Calling Conventions ..........................................................................................................................250

Comments ..........................................................................................................................250
Compiler Macros ..........................................................................................................................250
Pseudo Functions ..........................................................................................................................252
Helpers ..........................................................................................................................254
X# Expressions ...................................................................................................................................254
Bound Expressions ..........................................................................................................................256
Primary Expressions ..........................................................................................................................257
Codeblocks ..........................................................................................................................259
LINQ Expressions ..........................................................................................................................260
Initializers ..........................................................................................................................261
X# Operators ...................................................................................................................................262
Binary ..........................................................................................................................262
Assignment operators..........................................................................................................................264
Logical ..........................................................................................................................265
Bitw ise ..........................................................................................................................266
Relational ..........................................................................................................................267
Shift ..........................................................................................................................269
Unary ..........................................................................................................................269
Workarea ..........................................................................................................................270
X# Preprocessor Directives
...................................................................................................................................271
#command and #xcommand ..........................................................................................................................271
#define ..........................................................................................................................277
#else ..........................................................................................................................278
#endif ..........................................................................................................................279
#ifdef ..........................................................................................................................279
#ifndef ..........................................................................................................................279
#include ..........................................................................................................................280
#line ..........................................................................................................................280
#pragma ..........................................................................................................................280
#region - #endregion ..........................................................................................................................281
#translate and #xtranslate ..........................................................................................................................281
#undef ..........................................................................................................................287
X# Walkthroughs ...................................................................................................................................287
Pragma Statements ...................................................................................................................................287
X# Com piler Options ...........................................................................................................................................287
Command-line Building ...................................................................................................................................287
With xsc.exe
X# Compiler Options...................................................................................................................................289
By Category
X# Compiler Options...................................................................................................................................294
Listed Alphabetically
@ ..........................................................................................................................297
-additionalfile ..........................................................................................................................299
-addmodule ..........................................................................................................................299
-analyzer, -a ..........................................................................................................................300
-appconfig ..........................................................................................................................300
-az ..........................................................................................................................302
-baseaddress ..........................................................................................................................303
-checked ..........................................................................................................................303
-checksumalgorithm ..........................................................................................................................304
-codepage ..........................................................................................................................305
-cs ..........................................................................................................................305
-debug ..........................................................................................................................306
-define ..........................................................................................................................308
-delaysign ..........................................................................................................................309
-dialect ..........................................................................................................................310
-doc ..........................................................................................................................310
-errorendlocation ..........................................................................................................................311
-errorreport ..........................................................................................................................312
-filealign ..........................................................................................................................313

© 2015- 2019 XSharp BV

 Contents 6

-fovf ..........................................................................................................................314
-fullpaths ..........................................................................................................................314
-help, /? ..........................................................................................................................314
-highentropyva ..........................................................................................................................315
-i ..........................................................................................................................315
-ins ..........................................................................................................................316
-keycontainer ..........................................................................................................................317
-keyfile ..........................................................................................................................318
-langversion ..........................................................................................................................319
-lb ..........................................................................................................................319
-lib ..........................................................................................................................321
-link ..........................................................................................................................322
-linkresource ..........................................................................................................................324
-main ..........................................................................................................................326
-memvar ..........................................................................................................................326
-moduleassemblyname ..........................................................................................................................327
-modulename:<string>..........................................................................................................................329
-namedargs ..........................................................................................................................329
-noconfig ..........................................................................................................................330
-nologo ..........................................................................................................................330
-nostddefs ..........................................................................................................................331
-nostdlib ..........................................................................................................................331
-now arn ..........................................................................................................................332
-now in32manifest ..........................................................................................................................332
-ns ..........................................................................................................................333
-optimize ..........................................................................................................................335
-out ..........................................................................................................................336
-ovf ..........................................................................................................................337
-parallel ..........................................................................................................................337
-pathmap ..........................................................................................................................337
-pdb ..........................................................................................................................338
-platform ..........................................................................................................................338
-ppo ..........................................................................................................................340
-preferreduilang ..........................................................................................................................340
-recurse ..........................................................................................................................341
-reference ..........................................................................................................................342
-refonly ..........................................................................................................................344
-refout ..........................................................................................................................345
-resource ..........................................................................................................................346
-ruleset ..........................................................................................................................347
-s ..........................................................................................................................347
-show defs ..........................................................................................................................348
-show includes ..........................................................................................................................348
-snk ..........................................................................................................................349
-stddefs ..........................................................................................................................349
-subsystemversion ..........................................................................................................................349
-target ..........................................................................................................................351
-touchedfiles ..........................................................................................................................352
-undeclared ..........................................................................................................................352
-unsafe ..........................................................................................................................353
-utf8output ..........................................................................................................................354
-vo1 ..........................................................................................................................354
-vo10 ..........................................................................................................................355
-vo11 ..........................................................................................................................356
-vo12 ..........................................................................................................................356
-vo13 ..........................................................................................................................357
-vo14 ..........................................................................................................................359
-vo15 ..........................................................................................................................360

© 2015- 2019 XSharp BV

7 XSharp Bandol

-vo16 ..........................................................................................................................361
-vo2 ..........................................................................................................................362
-vo3 ..........................................................................................................................363
-vo4 ..........................................................................................................................364
-vo5 ..........................................................................................................................366
-vo6 ..........................................................................................................................367
-vo7 ..........................................................................................................................369
-vo8 ..........................................................................................................................371
-vo9 ..........................................................................................................................373
-w ..........................................................................................................................374
-w arn ..........................................................................................................................374
-w arnaserror ..........................................................................................................................375
-w in32icon ..........................................................................................................................376
-w in32manifest ..........................................................................................................................377
-w in32res ..........................................................................................................................378
-w x ..........................................................................................................................379
-xpp1 ..........................................................................................................................379
X# Com piler Errors
...........................................................................................................................................380
and Warnings
8 X#
...................................................................................................................................
Examples 380
Anonym ous Method...........................................................................................................................................380
Expressions
Anonym ous Types ...........................................................................................................................................380
ASYNC Exam ple ...........................................................................................................................................382
BEGIN UNSAFE Exam...........................................................................................................................................383
ple
BEGIN USING Exam...........................................................................................................................................384
ple
CHECKED Exam ple...........................................................................................................................................384
EVENT Exam ple ...........................................................................................................................................385
Expression Exam...........................................................................................................................................387
ples
FIXED Exam ple ...........................................................................................................................................388
GENERICs Exam ple...........................................................................................................................................388
Lam da Expressions
...........................................................................................................................................390
LINQ Exam ple ...........................................................................................................................................390
NOP Exam ple ...........................................................................................................................................392
SWITCH Exam ple ...........................................................................................................................................392
Typed Enum s ...........................................................................................................................................393
USING Exam ple ...........................................................................................................................................393
VAR Exam ple ...........................................................................................................................................394
Vulcan Runtim e (BYOR)
...........................................................................................................................................395
YIELD Exam ple ...........................................................................................................................................398

Index 400

© 2015- 2019 XSharp BV

Part

I
 9 XSharp Bandol

1 X# Documentation

Welcome to X# (XSharp) Bandol GA (2.0.6.0)

Click here for the version history

Click here for the list of known issues
X# is an open source development language for .NET, based on the xBase language.

It comes in different flavors, such as Core, Visual Objects, Vulcan.NET, xBase++,

Harbour, Foxpro and more.
The current version of X# supports the Core dialect as well as the VO, Vulcan and
Harbour dialect
A separate X# runtime is not available yet.
The VO & Vulcan dialect is supported both in combination with the Vulcan runtime as well
as with the X# runtime.
We have successfully compiled both the Vulcan SDK and applications that depend on this
SDK.
The Vulcan Runtime is part of the Vulcan.NET product.
You can download a free trial version of Vulcan.NET from www.govulcan.net and use the
runtime that comes with this trial version with X#.
The runtime in the trial version does not have any technical restrictions
Click here for the complete (but short) list of known issues

This documentation is still under development. Some sections in the documentation are
incomplete.

© 2015- 2019 XSharp BV

 X# Documentation 10

1.1 Getting Started with X#

The VO & Vulcan dialect is supported both in combination with the Vulcan runtime as well
as with the X# runtime.
We have successfully compiled both the Vulcan SDK and applications that depend on this
SDK.
The Vulcan Runtime is part of the Vulcan.NET product.
You can download a free trial version of Vulcan.NET from www.govulcan.net and use the
runtime that comes with this trial version with X#.
The runtime in the trial version does not have any technical restrictions
Click here for the complete (but short) list of known issues

Click here for the version history

Click here for the list of known issues

1.1.1 Version History

Changes in 2.0.6.0 (Bandol GA 2.06)

General
· We received a request to keep the version numbering simpler. For that
reason this new build is called Bandol 2.06 and the file versions for this
build are also 2.06. The assembly versions for the runtime assemblies
are all 2.0, and we intend to keep those stable as long as possible, so
you will not be forced to recompile code that depends on the runtime
assemblies.
· Several fixes that were meant to be included in 2.0.5.0 were not
included in that build. This has been corrected in 2.0 6.0

Compiler
· A missing ENDTEXT keyword now produces an error XS9086
· Unbalanced textmerge delimiters produce a warning XS9085
· The TEXT keyword in the FoxPro dialect is now only recognized when
it is the first non whitespace token on a line. As a result of this you can
use tokens like <text> in Preprocessor commands again.
· The VO cast operations on literal strings no longer produce a compiler
warning about possible memory leaks.

Runtime
· Runtime errors in late bound code were always shown as
TargetInvocationException. The true cause of the error was hidden
that way. We are now unpacking the error and rethrowing the original
error, including the callstack that was leading to that error
· Some texts in the string resources were updated
· Calling the Str() function with a -1 value for length and/or decimals
produced results that were not compatible with VO. This was fixed.
· Fixed a problem with DbZap() and files with a DBT memo.
· In some situations EOF and BOF were not set to TRUE when opening
an empty DBF file. This has been fixed.

© 2015- 2019 XSharp BV

11 XSharp Bandol

· PSZ values with an incorrect internal pointer are now displayed as

"<Invalid PSZ>(..)"

RDD System
· The code to read and write to columns in an Advantage workarea now
uses separate column objects, just like the code for the DBF RDD.
This makes the code a bit easier to understand and should make the
code a bit faster.

VS Integration
· The text block between TEXT and ENDTEXT is now displayed in the
same color as literal strings
· The VO compatible Project Item templates no longer automatically add
references to your project
· Project files from version 2.01.0 and later will no longer be "touched"
when opening with this version of the X# project system, since there
have been no changes to the project file format since that build.

VOXporter
· The CATCH block in the generated Start function now calls
ErrorDialog() to show the errors. This uses the new language
resources to display the full error with VO compatible error information
(Gencode, Subcode etc)

Changes in 2.0.5.0 (Bandol GA 2.01)

Compiler
· Blank lines after an END PROPERTY could confuse the compiler.
This has been fixed
· The TEXT .. ENDTEXT command has been implemented in the
compiler (FoxPro dialect only)
· The \ and \\ commands have been implemented (FoxPro dialect only)
· Procedures in the FoxPro dialect may now return values. Also the /vo9
options is now enabled by default in the FoxPro dialect. The default
return value for a FUNCTION and PROCEDURE is now TRUE in the
foxpro dialect and NIL in the other dialects.
· Error messages no longer refer to Xbase types by their internal names
(XSharp.__Usual) but by their normal name (USUAL).

MacroCompiler
· Creating classes with a namespace prefix was not working. This has
been fixed.

Runtime
· Fixed a problem with ArrayNew() and multiple dimensions
· When calling constructor of the Array class with a number the
elements were already initialized. This was not compatible with

© 2015- 2019 XSharp BV

 X# Documentation 12

Vulcan.NET. There is now an extra constructor whtich takes a logical

parameter lFill which can be used to automatically fill the array
· The text for the ERROR_STACK language resource has been
updated
· Calling Str() with integer numbers was returning a slightly different
result from VO. This has been fixed.
· Added support functions for TEXT .. ENDTEXT and TextMerge and an
output text file.
· Fixed a problem in the DTOC() function
· You can now add multiple ImplicitNamespace attributes to an
assembly
· We have added several FoxPro system variables (only _TEXT does
something at this moment)

RDDs
· Zap and Pack operations were not properly setting the DBF file size
· An Append() in shared mode was not properly setting the RecCount
· Opening a file with one of the Advantage SQL RDDs was not working.
This has been fixed.
· Writing DateTime.Minvalue to a DBF would not write an empty date but
the date 1.1.1 This has been fixed.

VO SDK
· Fixed a problem in ListView:EnsureVisible().
· Some questionable casts (such as the one that cause the previous
problem) have been cleaned up

Visual Studio Integration

· Parameter tips for constructor calls were off by one parameter. This
has been fixed.
· When looking for types, the XSharp namespace is now the first
namespace that is searched.

Changes in 2.0.4.0 (Bandol GA)

Compiler
· Fix a problem in assignment expressions where the Left side is an
aliased expression with a workarea in parentheses:
(nArea)->LastName := AnotherArea->LastName
· Multiline statements, such as FOR blocks, no longer generate Multiline
breakpoints in the debugger.
· Fixed a problem where blank lines or lines with 'inactive' preprocessor
comments after a class definition would generate a compiler error.
· Errors for implicit conversions between INT/DWORD and PTR now
produce a better error message when they are not supported.

© 2015- 2019 XSharp BV

13 XSharp Bandol

· USUAL.ToObject() could not be called with the latebinding compiler

option was enabled. This has been fixed.
· Fixed an internal compiler error with untyped STATIC LOCALs.
· Fixed a problem with aliased expressions.
· Indexing PSZ values is no longer affected by the /az compiler option

MacroCompiler
· Fixed a problem with some aliased expressions
· The macro compiler now detects that you are overriding a built-in
function in your own code and will no longer throw an "ambigous
method" exception but will choose function from your code over
functions defined in the X# runtime

Runtime
· FIxed several problems in the Directory() function
· Fixed problem with indexing PSZ values
· Added StackTrace property on the Error object so also errors caught
in a BEGIN SEQUENCE will have stack information.
· Fixed problems with "special" float values and ToString(), such as
NaN, PositiveInfinity
· Fixed a problem with RddSetDefault() with a null parameter
· DbInfo(DBI_RDD_LIST) was not returning a value. This has been
fixed.
· We have updated many of the language resources, Also the
Error:ToString() now uses the language resources for captions like
'Arguments' and 'Description'.
· Low level file errors now include the callstack
· Fixed some problems in AsHexString()
· The DosErrString() no longer gets its messages from the language
string tables. The messages have been removed and also the related
members in the XSharp.VOErrors enum.
· Added a Turkish language resource.

RDD System
· Fix locking problem in FPT files
· Fixed several problems with OrdKeyCount() and filters, scopes and
SetDeleted() setting
· Some DBF files have a value in the Decimals byte for field definitions
for field types that do not support decimals. This was causing
problems. These decimals are now ignored.
· Opening and closing a DBF without making changes was updating the
time stamp. This has been fixed.
· Fixed problems in Pack() and Zap()
· Fixed a problem where custom indexes were accidentally updated.
· Fixed several problems with OrdKeyCount() in combination with
Filters, SetDeleted() and scopes.

© 2015- 2019 XSharp BV

 X# Documentation 14

VO SDK Classes
· Most of the libraries now compile with "Late Binding" disabled for better
performance.
To help in doing this some typed properties have been added such as
SqlStatement:__Connection which is typed as SQLConnection.

Visual Studio integration

· Fixed a problem in the Brace matching code
· Improved Brace matching for keywords. Several BEGIN .. END
constructs have now been included as well as CASE statements
inside DO CASE and SWITCH, RECOVER, FINALLY, ELSE, ELSEIF
and OTHERWISE
· Fix a problem with adding and deleting references when unloaded or
unavailable references existed.

VOXPorter
· The program is now able to comment, uncomment and delete source
code lines from the VO code when exporting to XSharp.
You have to add comments at the end of the line. The following
comments are supported:
// VXP-COM : comments the line when exporting it
// VXP-UNC : uncomments the line
// VXP-DEL : deletes the line contents

example:
// METHOD ThisMethodDoesNotGetDefinedInVOcode() // VXP-UNC
// RETURN NIL // VXP-UNC
Changes in 2.0.3.0 (Bandol RC3)

Compiler
· Code generation for STATIC LOCALs of type STRING was not
initializing the variables to an empty string when /vo2 was selected.
We have also improved code generation for STATIC LOCALs when
they are initialized with a compile time constant
· In preparation for the support for variables passed by reference to
functions/methods with clipper calling convention we are now
assigning back the locals variables to the parameter array at the end of
a function/method with clipper calling convention.
· The compiler would not complain if you were assigning a value of one
enum to a variable of another enum. This has been fixed.
· Added support for the FoxPro '=' assignment operators. Other dialects
also allow the assignment operator but a warning is generated in the
other dialects.
· Xbase++ classes inside BEGIN NAMESPACE .. END NAMESPACE
were not recognized. This has been fixed.
· Statements inside WITH blocks are no longer constrained to
assignment expressions and method calls. You can now use the
WITH syntax for expressions anywhere inside a WITH block. If the

© 2015- 2019 XSharp BV

15 XSharp Bandol

compiler can't find the WITH variable then it will output a new error
message (XS9082)
· Updated the Aliased Expression rules to make sure that compound
expressions properly respect the parentheses.
· The __DEBUG__ macro was not always set correctly. We have
changed the algorithm that sets this macro. When the DEBUG define
is set then this macro gets defined. When the NDEBUG define is set
then this macro is not defined. When both defines are absent then
__DEBUG__ is NOT set.
· The compiler was allowing you to use the '+' operator between
variables/ expressions of type string and logic. This is now flagged as
an error.

MacroCompiler
· Fixed a problem with resolving Field names that were identical to
keywords or keyword abbreviations (for example DATE and CODE)
and for Field names that are equal to built-in function names (such as
SET)
· Fixed a problem where a complicated expression evaluated with an
alias prefix was not evaluated correctly.
· The macro compiler initializes itself from the Dialect option in the
runtime to enable/disable certain behavior.
· The macro compiler now recognizes the "." operator for workarea
access and memvar access when running in the FoxPro dialect.

Runtime
· Added functions FieldPutBytes() and FieldGetBytes()
· Added function ShowArray()
· Added several defines that were missing, such as MAX_ALLOC and
ASC_A.
· Added Crypt() overloads that accept BYTE[] arguments
· The ClassDescribe() method for DataObject classes (XPP dialect)
now includes properties and methods that were dynamically added.
· Fixed a problem with the RELEASE command for MemVars. This was
also releasing variables defined outside the current function / method.
· There is now also a difference between the FoxPro dialect and other
dialects in the behavior of the RELEASE command.
FoxPro completely deletes the variables, the other dialect set the value
of the variables to NIL.
· New PRIVATE memvars are initialized to FALSE in the FoxPro dialect.
In the other dialects they are initialized to NIL.
· Some numeric properties in the RuntimeState were giving a problem
when a numeric of one type was written and another numeric type was
expected when reading. This has been fixed.
· Fixed a problem with return NIL values from Macro compiled
codeblocks.
· The parameter to DbClearScope() is now optional
· The USUAL type now allows to compare between values of type PTR
and LONG/INT64 The PTR value is converted to the appropriate
Integral type and then an Integral comparison is done.

© 2015- 2019 XSharp BV

 X# Documentation 16

· The USUAL type now also allows comparisons between any type and
NIL.
· Casts from USUAL values to SHORT, WORD, BYTE and SBYTE are
no longer checked to be compatible with VO.

RDD System
· Added support for different block sizes in DBFFPT.
· DBFFPT now allows to override the block size (when creating) from
the users code. Please note that block sizes < 32 bytes prevent the
FPT from opening in Visual FoxPro.
· Added support for reading various Flexfile memo field types, including
arrays.
· Added support for writing to FPT files
· When creating FPT files we now also write the FlexFile header. Please
note that our FPT driver does not support "record recycling" for deleted
blocks like FlexFile does. We also only support writing STRING values
to FPT files and Byte[] values.
· Added support for Visual FoxPro created CDX files that were created
with the COLLATE option. The RDD dll now contains collation tables
for all possible combinations of collation and CodePage.
· Added support for USUALs with a NIL value and the comparison
operators (>, >=, <, <=). These operators return FALSE, except the
>= and <= operators which return TRUE when both sides of the
comparison are NIL.
· We exposed several Advantage related function and types. Also the
function AdsConnect60() was defined. We have not created functions
for all available functions in Ace32 and Ace64, but only the ones
needed in the RDD.
· If you are missing a function in the ACE class, please let us know. All
functions should be available and accessible now in the Ace32 and
Ace64 classes or in the ACEUNPUB32 or ACEUNPUB64 classes.
· The ADS RDD was returning incorrect values for LOGIC fields.
· Fixed some problems with skipping in CDX indexes and scopes and
filters.
· Executing DbGoTop() twice or DbGoBottom() twice for DBFCDX
would confuse the RDD. This has been fixed.
· Fixed a problem with Seeking() in an empty DBF file
· FieldPut for STRING fields in the Advantage RDD now truncates the
fields to the maximum length of the field before assigning the value
· Fixed a problem with UNIQUE CDX Indexes.
· You can now create VFP compatible DBF files with DBCreate(). To do
so use the following field types (apart from the normal CDLMN):
W Blob
Y Currency
B Double
T DateTime
F Float
G General
I Integer
P Picture

© 2015- 2019 XSharp BV

17 XSharp Bandol

Q Varbinary
V Varchar
Special field flags can be indicated by adding a suffix to the type:
"0" = Nullable
"B" = Binary
"+" = AutoIncrement
So this creates a nullable date: "D0" and this creates an autoincremental
integer "I+".
Auto increment columns are initialized with a counter that starts with 1
and a step size of 1. You can change that by calling DbFieldInfo:
DbFieldInfo(DBS_COUNTER, 1, 100) // sets the counter for field
1 to 100
DbFieldInfo(DBS_STEP, 1, 2) // sets the step size for
field 1 to 2
· Fixed a locking problem with FPT files opened in shared mode
· Fixed several problems related to OrderKeyCount() and various
settings of Scopes and SetDeleted() in the DBFCDX RDD.

VO SDK Classes
· Fixed a problem in the DateTimePicker class when assigning only a
time value.
· System classes and RDD classes have been cleaned up somewhat
and now compile in AnyCPU mode. So this means that you can use
the DbServer class in a 64 bit program !
The projects for these two libraries also no longer have the "Late
Binding" compiler option enabled. There is still some late bound code
in these libraries but this code now uses explicit late bound calls such
as Send(), IVarGet() and IVarPut().
· Because of the change in the handling of __DEBUG__ some SDK
assemblies are not better optimized.

Visual Studio integration

· Added support for WITH .. END WITH blocks in the editor
· When generating Native Resources (RC files) the BuildSystem now
sets a #define __VERSION__. This will have the fileversion number of
the XSharp.Build.DLL without the dots. (2.1.0.0 will be written as
"2100")
· The XSharp help item in the VS Help menu now opens the local Help
(CHM) file
· Fixed a problem in the WCF service template
· Correction to the multi line indenting for code that uses attributes
· Code generation for new Event handlers now includes a RETURN
statement, even when VS does not add one to the statement list
· The intellisense option "Show completionlist after every character" has
been disabled since it was having a negative impact on performance
and would also insert keywords with @@ characters in front of them.
· Several changes to the code parsing for the Windows Forms editor.
Comments and Regions should now be saved and regenerated as
well as attributes on classes. Also code generation for images from
project resources has been fixed as well as parsing of static fields and
enumerators declared in the same assembly.

© 2015- 2019 XSharp BV

 X# Documentation 18

Please note. If you are using values from types defined in the same
assembly as the form then the assembly needs to be (re)compiled
first before the form can be successfully opened in the Windows
Forms Editor.
· New methods generated from the Windows forms editors will now be
generated with a closing RETURN statement.
· We have made some improvements to the presentation of QuickInfo in
the source code editor.

Tools
· VOXporter now also exports VERSIONINFO resources
Changes in 2.0.2.0 (Bandol RC 2)

Compiler
· File wide PUBLIC declarations (for MEMVARs) were incorrectly parsed
as GLOBALs. Therefore they were initialized with NIL and not with
FALSE. They are now generated correctly as public Memvars. The
creation of the memvars and the initialization is done in after the Init3
procedures in the assembly have run.
· Instance variable initializers now can refer other fields and are allowed
to use the SELF keyword. This is still not recommended. The order in
which fields are initialized is the order in which they are found in the
source code. So make sure the field initializers are defined in the right
order in your code.
· AUTO properties are now also initialized with an empty string
when /vo2 is enabled.
· The compiler was allowing you to define instance variables for
Interfaces. They were ignored during code generation. Now an error
message is produced when the compiler detects fields on interfaces.
· When the compiler detects 2 ambiguous symbols with different types
(for example a LOCAL and a CLASS with the same name) then the
error message now clearly indicates the type for each of these
symbols.
· Fixed an exception in the Preprocessor
· Added support for the FoxPro runtime DLL.
· The ANY keyword (an alias for USUAL) is no longer supported.
· Keywords that appear after a COLON (":") DOT (".") or ALIAS (->)
operator are no longer parsed as keyword but as identifier. This should
solve issues with parsing code that for example accesses the Date
property of a DateTime class.
· We have added support for the WITH .. END WITH statement block:

LOCAL oPerson as Person

oPerson := Person{}
WITH oPerson
:FirstName := "John"
:LastName := "Doe"
:Speak()
END WITH
You can also use the DOT (.) as prefix for the names. The only

© 2015- 2019 XSharp BV

19 XSharp Bandol

expressions allowed inside WITH .. ENDWITH are assignments and

method calls (like you can see above)
· Added support for the FoxPro LPARAMETERS statement. Please not
that a function or procedure can only have a PARAMETERS keyword
OR a LPARAMETERS keyword OR declared parameters (names
between parentheses on the FUNCTION/PROCEDURE line)
· Added support for the FoxPro THIS keyword and .NULL. keyword
· We have added support for the FoxPro Date Literal format {^2019-06-
21} and FoxPro DateTime Literals {^2019-06-21 23:59:59}.
· Date literals and DateTime literals are now also supported in the Core
dialect. Date Literals will be represented as DateTime values in the
Core dialect.
· The standard header file xsharpdefs.xh now conditionally includes
header files for the Xbase++ dialect and FoxPro dialect. These header
files do not have much content at this moment, but that will change in
the coming months.
· When the compiler detects that some header files are included but
that the defines in these header files are also available as constants in
references assemblies then a warning will be generated and the
include file will be skipped (XS9081)
· The compiler now supports an implicit function _ARGS(). This will be
resolved to the arguments array that is passed to functions/methods
with clipper calling convention. This can be used to pass all the
arguments of a function/method to another function/method.
· We have added the TEXT ... ENDTEXT command for the FoxPro
dialect. The string inbetween the TEXT and ENDTEXT lines is passed
to a special runtime function __TextSupport that will receive 5
parameters: the string, the merge, NoShow, Flags and Pretext
arguments. You will have to define this function yourself for now. it will
be included in the XSharp Foxpro runtime in a future version.
· We have added support for END keywords for all entity types that did
not have one yet. The new end keywords are optional. They are listed
in the table below. The FoxPro ENDPROC and ENDFUNC keywords
will be mapped to END PROCEDURE and END FUNCTION with a
UDC.

Start End
PROCEDURE END PROCEDURE
PROC END PROC
FUNCTION END FUNCTION
FUNC END FUNC
METHOD END METHOD
ASSIGN END ASSIGN
ACCESS END ACCESS
VOSTRUCT END VOSTRUCT
UNION END UNION

© 2015- 2019 XSharp BV

 X# Documentation 20

· The compiler now registers the Dialect of the main in the Dialect
property of the RuntimeState (Non Core dialects only)

MacroCompiler
· Fixed a problem with escaped literal strings
· Fixed a problem with implicit narrowing conversions
· Fixed a problem with macro compiled alias operations (Customer)-
>&fieldName

Runtime
· Fixed a problem in the Round() function.
· Fixed a problem in the ExecName() function.
· Added FoxPro runtime DLL.
· Added XML support functions in the Xbase++ dialect runtime
· Added support for dynamic class creation in the Xbase++ dialect
runtime.
· Fixed a problem in the Push-Pop workarea code for aliased
expressions.
· converting a NULL to a symbol would cause an exception. This has
been fixed.

RDD system
· Fixed several problems in the ADS RDD
· The DBFCDX RDD is now included
· The DBFVFP RDD is now included. This RDD can be used to access
files with DBF/FPT/CDX extension and support the Visual Foxpro field
types, such as Integer, Double, DateTime and VarChar. Reading files
should be fully supported. Writing should also work with the exception
of the Picture and General formats and with the exception of the
AutoIncremental Integer fields. You can also use the RDD to open the
various "definition" files from VFP such as projects, forms and reports.
The RDD 'knows' about the different extensions for indexes and
memos. You can also open DBC files as normal tables. In a future
version we will support the VFP database functionality.

Visual Studio Integration

· You can now specify that multi line statements should indent on the
2nd and subsequent lines.
· Type lookup for functions inside a BEGIN NAMESPACE .. END
NAMESPACE did not include the types in this namespace.
· Started intellisense for INLINE methods in the Xbase++ dialect
· Fixed several problems in intellisense
· Improved intellisense for VAR keywords declared in a FOREACH loop
· Several other (smaller) improvements.

© 2015- 2019 XSharp BV

21 XSharp Bandol

Tools
· VOXporter now writes DEFINES in the RC files and no longer literal
values.
· VOXporter: fix for module names with invalid chars for filenames

Changes in 2.0.1.0 (Bandol RC 1)

Compiler
· Added support for the so called IF Pattern Expression syntax, which
consists of an IS test and an assignment to a variable, prefixed with
the VAR keyword:
IF x is Foo VAR oFoo
? oFoo:DoSomething()
ENDIF

The variable oFoo introduced in the expression will only be visible

inside the IF statement.
Of course you can also use the pattern on other places, such as
ELSEIF blocks, CASE statements, WHILE expressions etc:

IF x is Foo VAR oFoo

? oFoo:DoSomething()
ELSEIF x is Bar VAR oBar
? oBar:DoSomethingElse()
ENDIF

· Fixed a problem with method modifiers and generic methods

· Fixed a problem with partial classes with different casing and
destructors
· Fixed a problem with Interfaces and methods with CLIPPER calling
convention
· The compiler now generates an error (9077) when an ACCESS or
ASSIGN method has Type Parameters and/or Constraint clauses
· Fixed a problem with DEFINEs with specific binary numeric values.
Also overflow checking is now always of when calculating the result of
numeric operations for the values of a DEFINE.
· When a constant value was added or subtracted to a numeric value <
32 bits then the result was seen as 32 bits by the compiler. This
sometimes forced you to use casts in your code. With this change that
cast is no longer necessary.
· The compiler allowed you to concatenate non string values and strings
and was automatically calling ToString() on the non strings. This is no
longer possible. The compiler now generates an error (9078)when it
detects this.
· We have added error trapping code to the compiler that should route
internal errors to compiler error XS9999. If you see such an error,
please let us know.
· DIM arrays of literal strings are now initialized properly.

© 2015- 2019 XSharp BV

 X# Documentation 22

· There was a problem when switching between dialects when using the
shared compiler. It would sometimes no longer detect dialect specific
keywords. This has been fixed.
· Fixed a problem where incorrect code was producing an error "Failure
to emit assembly"
· Fixed a problem in code that uses _CAST to cast a 32 bits value to 16
bits
· Fixed a problem with overloaded indexed properties where the index
parameter in a subclass has a different type than the index parameter
in the super class.
· Changed implementation of several aliased operations (ALIAS->FIELD
and (ALIAS)->(Expression))
· Changed preprocessor handling of extended strings ( (<token>) )
· The Roslyn code was not marking some variables as 'assigned but
not read' to be compatible with the old C# compiler. We are now
flagging these assignments with a warning. This may produce a lot of
warnings in your code that were not detected before.
To support this we have received some requests to "open up" the
support for 1 based indexes in the compiler. In the past the compiler
would only allow 1 based indexing for variables of type System.Array or
of the XBase ARRAY Type.
We have now added a couple of interfaces to the runtime. If your type
implements one of these interfaces then the compiler will recognize
this and allow you to use 1 based indexes in your code and then the
compiler will automatically subtract 1 from the numeric index
parameter. The XSharp ARRAY type and ARRAY OF type now also
implement (one of) these interfaces/
The interfaces are:
INTERFACE IIndexer
PUBLIC PROPERTY SELF[index PARAMS INT[]] AS USUAL GET SET
END INTERFACE

INTERFACE IIndexedProperties
PROPERTY SELF[index AS INT ] AS USUAL GET SET
PROPERTY SELF[name AS STRING] AS USUAL GET SET
END INTERFACE
INTERFACE INamedIndexer
PUBLIC PROPERTY SELF[index AS INT, name AS STRING] AS USUAL
GET SET
END INTERFACE

Runtime
· Fixed some problems in the OrderInfo() function
· Fixed several problems with DB..() functions in the runtime
· Fixed several problems with the macro compiler
· Fixed a problem with the handling of default parameters in late bound
calls to methods
· Improved error messages for missing methods and/or properties in
late bound code.
· The Select() function was changing the current workarea. This has
been fixed.

© 2015- 2019 XSharp BV

23 XSharp Bandol

· Converting a USUAL to a STRING was not throwing the same

exceptions as VO. It was always calling ToString() on the USUAL. Now
the behavior is the same as in VO.
· F_ERROR has been defined as a PTR now and no longer as numeric
· CreateInstance can now also find classes defined in namespaces
· Fix problems with missing parameters in late bound code. Also added
(limited) support for calling overloaded methods and constructors in
late bound code.
· Fixed problems with TransForm(), and several of the Str() functions.
· XSharp.Core is now fully compiled as Safe code.
· Fixed a problem with late bound assigns and access
· NIL<-> STRING comparisons are now compatible with Visual Objects
· Fixed problem with AEval() and missing parameters
· Added Set() function. Please be careful when using header files for
_SET defines. There are subtle differences between the definitions in
Harbour, Xbase++ and VO/Vulcan.
We recommend NOT to use the defines from the header file but to use
the defines that are defined inside the X# runtime DLLs
· Changed implementation of the functions used by the compiler for
Aliased operations

RDD system
· Added support for DBF character fields up to 64K.
· Implemented the DBFCDX RDD
· Fixed several problems related to the DBFNTX RDD
· The DBF RDD was using the incorrect locking scheme for Ansi DBF
files. It now uses the same scheme as VO and Vulcan.
· Macro compiled index expressions are not of the type _CodeBlock and
not of the type RuntimeCodeBlock (the RuntimeCodeblock is
encapsulated inside the _CodeBlock object).
That prevents problems when storing these expressions inside a
USUAL

Visual Studio integration

· Fixed an exception that could occur when typing a VAR expression
· When the project system makes a backup of a project file, we are now
making sure that Readonly flags are cleared before writing to or
deleting existing files.
· Reading intellisense data from C++ projects could send the
intellisense engine into an infinite loop. This has been fixed.
· The changes to the Form.Designer.prg are now written to disk
immediately, to make sure that changes to the form are recompiled if
you press 'Run' or 'Debug' from the window of the form editor
· Improved support for intellisense for the VAR keyword.
· Added support for FoxPro on the Project Properties page to prepare
for the Compiler and Runtime changes for FoxPro.
· .CH files are now also recognized as "X#" files in Visual Studio.
· You can now control the characters that select an entry from a
Completion List. For example the DOT and COLON now also select

© 2015- 2019 XSharp BV

 X# Documentation 24

the current selected element. The complete list can be found on the
Tools-Options-TextEditor-XSharp-Intellisense page.
· Assemblies added to a project would not be properly resolved until the
next time the project was loaded. This has been fixed.
· Fixed a problem in the codedom parser which feeds the windows form
editor. You can now inherit a form from another form in the same
assembly. You will have to compile the project first (of course).
· The .CH extension is now also registered as relevant for the X# project
system.
· Changed auto indentation for #ifdef commands
· Fixed an exception that could occur during loading of project files with
COM references.
· Added templates for class libraries in XPP and VO Dialect
· Sometimes a type lookup for intellisense was triggered inside a
comments region. This has been fixed.

Tools
· VOXPorter was not removing calling conventions when creating
delegates. This has been fixed
· VOXporter was sometimes generating project files with many
duplicates of resource items. This has been fixed.
· VOXporter now marks prefix identifiers that conflict with one of the new
keywords with "@@"
· The delay for the VOXporter welcome screen has been shortened.
Changes in 2.0.0.9 (Bandol Beta 9)

Compiler
· The Lexer (the part of the compiler that recognizes keywords, literals
etc) has been rewritten and is slightly faster.
· The compiler now supports digit separators for numeric literals. So
you can now write 1 million as:
1_000_000
· Fixed problem where static local variables were not initialized with ""
even when compiler option -vo2 was selected
· #ifdef commands using preprocessor macros such as
__XSHARP_RT__ were not working correctly.
· The XBase++ dialect now also supports the 'normal' class syntax.
· We had changed the 'Entrypoint' algorithm in Beta 8. This has been
restored now and the -main command line option now works again as
well. In stead the "body" of the Start method is now encapsulated in an
anonymous function.
· Duplicate include files no longer produce an error but a warning
· Fix for problem with default parameter values with 'L' or 'U' suffix
· Added compiler error when specifying default parameter values for
methods/functions with clipper calling convention
· DIM arrays of STRING were not initialized with "" when /vo2 was
specified. This has been fixed.
· Added support for Dbase style memory variables (MEMVAR, PUBLIC,
PRIVATE, PARAMETERS). See the MEMVAR topic in the help file for

© 2015- 2019 XSharp BV

25 XSharp Bandol

more information. This is only available for certain dialects and also
requires the /memvar commandline option
· Added support for undeclared variables (this is NOT recommended!).
This is only available for certain dialects and requires the /memvar
AND the /undeclared commandline options
· Fixed a problem for comparisons between USUAL variables and
STRING variables
· Fixed a problem with partial classes where the classname had
different casing in the various declarations
· Fixed a problem with numeric default parameters with L or U suffixes
· Fixed a problem with line continuation semi colons followed by a single
line comment with the multiline comments style.
· Fixed a problem with methods containing YIELD statements in
combination with compiler option /vo9
· When a visibility modifier was missing on a generic method then this
method was created as a private method. This has been fixed.
· When choosing between overloaded functions in XSharp.RT and
XSharp.Core the function in the XSharp.RT assembly would
sometimes be chosen although the overload in XSharp.Core was
better
· CASE statements without CASE block but only a OTHERWISE block
would crash the compiler. This has been fixed and an warning about
an empty CASE statement has been added.

Runtime
· Several changes to the Macro compiler, such as the parsing of Hex
literals, case sensitivity of parameters (they are no longer case
sensitive) and limited support for function overloading.
· Several missing functions have been added, such as _Quit(),
· The return value of several Ord..() functions was incorrect. This has
been fixed.
· Fixed a problem with CurDir() for the root directory of a drive
· Fixed a problem with calling Send() with a single parameter with the
value NULL_OBJECT.
· Solved problem with incorrect parameters for DiskFree() and
DiskSpace()
· MemoRead() and MemoWrit() and FRead..() and FWrite..() now
respect the SetAnsi() setting like the functions in the VO Runtime.
· We have added 2 new functions to read/write binary files:
MemoReadBinary() and MemoWritBinary()
· Not all DBOI_ enum values had the same value as in Vulcan. This has
been solved.
· SetDecimalSep() and SetThousandSep() now also set the numeric
separators in the current culture.
· The USUAL -> STRING conversion now calls AsString()
· Added support for Dbase style dynamic memory variables (MEMVAR,
PUBLIC, PRIVATE, PARAMETERS). See the Memory Variables topic
in the help file for more information.
· The IsDate() function now also returns TRUE for USUALs of type
DateTIme. There is also a separate IsDateTime() function. We have

© 2015- 2019 XSharp BV

 X# Documentation 26

also added IsFractional() (FLOAT or DECIMAL) and IsInteger (LONG

or INT64) and IsInt64()
· Added missing Cargo slot to the Error class. Also improved
Error:ToString()
· Fix for problem in W2String()
· And many more small changes.

Visual Studio Integration

· We have added a new tab page in the Project Properties dialog:
Dialect. This contains dialect specific language options.
· 2 options from the Build options page (which is configuration
dependent) have been moved to the Language page (which is build
INdepedent), because that makes more sense:
· Include Path
· NoStdDef
· We have also added a project property on the Language page to
specify an alternative standard header file (in stead of XSharpDefs.xh)
· The XSharp.__Array type was shown in the intellisense with the wrong
name
· We have added entries on the Project Properties dialog pages to
enable MEMVAR support and to enable Undeclared variables
· Fixed a problem in the CodeDom provider (used by the Windows
Form editor) where fields with array types were losing their array
brackets when writing back to the source.
· When writing changes from the windows form editor we are no longer
writing to disk but to the opened (sometimes invisible) windows of the
.designer.prg. This should prevent warning messages about the
.designer.prg file that was changed outside Visual Studio
· Fixed a problem parsing source code where identifier names were
starting with '@@'
· The Debugger was showing UINT64 as typename for ARRAYs. This
has been fixed.
· Renaming forms in the Windows Forms editor was not working for
forms with a separate .designer.prg. This has been fixed.
· Fixed a (very old) problem where the OutPutPath property in the xsproj
file was sometimes set to $(OutputPath).
· Fixed an exception in the editor for empty source files or header files.
· Fixed an exception when the error list was created for errors without
errorcode
· Commenting a single line in the editor will now always use the //
comment format

Tools
· No changes in this release.

© 2015- 2019 XSharp BV

27 XSharp Bandol

Changes in 2.0.0.8 (Bandol Beta 8)

Compiler
· The compiler source code has been upgraded to Roslyn 2.10 (C# 7.3).
As a result of that there are some new compiler options, such
as /refout and we also support the combination of the "PRIVATE
PROTECTED" modifier that defines a type member as accessible for
subclasses in the same assembly but not for subclasses in other
assemblies
· We have added support for XBase++ class declarations. See the
XBase++ class declaration topic for more information about the syntax
and what is supported and what not.
· We have added support for simple macros with the &Identifier syntax
· We have added support for late bound property access:
o The <Expression>:&<Identifier> syntax.
This translates to IVarGet(<Expression>,
<Identifier>).
o The <Expression>:&(<Expression2>) syntax.
This translates to IVarGet(<Expression>,
<Expression2>).
o Both of these can also be used for assignments
and will be translated to IVarPut:
<Expression>:&<Identifier> := <Value>
This becomes IVarPut(<Expression>, <Identifier>,
<Value>)
o All of these will work even when Late Binding is not
enabled.
· We have added a new compiler options /stddefs that allows you to
change the standard header file (which defaults to XSharpDefs.xh)
· We have added a new preprocessor Match marker <#idMarker> which
matches a single token (all characters until the first whitespace
character)
· When you select a dialect now, then the compiler will automatically
add some compiler macros. The VO dialect declares the macro
__VO__, the Vulcan dialect declares the macro __VULCAN__ the
harbour dialect declares the macro __HARBOUR__ and the XBase++
dialect declares the macro __XPP__.
· When compiling against the X# runtime then also the macro
__XSHARP_RT__ will be defined.
· We have added a new warning when you pass a parameter without
'ref' modifier (or @ prefix) to a method or function that expects a
parameter by reference or an out parameter.
· We have also added a warning that will be shown when you assign a
value from a larger integral type into a smaller integral type to warn you
about possible overflow problems.

Runtime
· This build includes a new faster macro compiler. It should be fully
compatible with the VO macro compiler. Some of the .Net features are
not available yet in the macro compiler.

© 2015- 2019 XSharp BV

 X# Documentation 28

· We moved most of the generic XBase code to XSharp.RT.DLL.

XSharp.VO.DLL now only has VO specific code. We have also added
XSharp.XPP.DLL for XPP
· Fix Ansi2OEM problem with FRead3(), FWrite3() and FReadStr
· Added missing functions EnableLBOptimizations() and property
Array:Count
· Fixed problem with latebound assign with CodeBlock values
· Fixed problem with AScan() and AEval() with missing parameters
· Changed error return codes for DirChange(), DirMake() and
DirRemove()
· Send() was "swallowing" errors. This has been fixed
· Fixed a problem with assigning to multi dimensional arrays
· Fixed a problem with creating objects with CreateInstance() where
objects are not in the "global" namespace
· Fixed several problems in the RDD system and support functions.
· Fixed several problems in the late binding support, such as IsMethod,
IsAccess, IVarPut, IVarPutSelf etc.
· Fixed several problems with TransForm()
· Integer divisions for usuals containing integers now return either
integers or else fractional numbers depending on the compiler setting
of the main app.
· We fixed several conversions problems during late bound calls
· We have fixed several problems with the Val() and Str() functions.
· The internal type names for DATE and FLOAT have been changed to
__Date and __Float. If you rely on these type names please check
your code !
· DebOut32 was not outputting data to the debug terminal if the runtime
was compiled in release mode. This has been fixed.

Visual Studio Integration

· Fixed filtering on 'current project' in the error list
· Type lookup for local variables was sometimes failing. This has been
fixed
· Fixed a problem with Brace Matching that could cause an exception in
VS
· Fixed a problem with Tooltips that could cause an exception in VS
· Fixed a problem with uncommenting that could cause an exception in
VS
· New references added in VS would not always be included in the type
search in the editor. This has been fixed.
· Member prototypes for constructors now include the type name and
curly braces
· We have started work on improved code completion for variables
declared with VAR
· We have started with support for code completion for members of
Generic types. This is not finished yet.
· PRG files that are not part of a X# project and not part of a Vulcan
project are now also colorized in the editor.

© 2015- 2019 XSharp BV

29 XSharp Bandol

Tools
· VulcanXPorter was always adjusting the referenced VO libraries and
was ignoring the "Use X# Runtime" checkbox
· VOXPorter now has an option to copy the resources referenced in the
AEF files to the Resources subfolder in the project
· VOXPorter now also copies the cavowed, cavofed and cavoded
template files to the properties folders in your project.
Changes in 2.0.0.7 (Bandol Beta 7)

Compiler
· When calling a runtime function with a USUAL parameter the compiler
now automatically prefers methods or functions with "traditional' VO
types over the ones with enhanced .Net types. For example when
there are 2 overloads, one that takes a byte[] and another that takes a
string, then the overload that takes a string will get preference over the
overload that takes a byte[].
· Resolved a problem with .NOT. expressions inside IIF() expressions
· Improved debugger break point generation for Invoke expressions ( like
String.Compare())
· Fixed a pre-processor error for parameters for macros defined in a
#define. These parameters must have the right case now. Parameters
with a different case will not be resolved any longer.
· Fixed a pre-processor error where optional match patterns in pre-
processor rules were repeated. This is too complicated to explain here
in detail <g>.
· The code generated by the compiler for Array operations now uses the
new interfaces declared in the X# runtime (see below).

Runtime
· We have added several missing functions, such as _GetCmdLine,
Oem2AnsiA() and XSharpLoadLibrary
· Fixed problems in CreateInstance, IVarGet, IVarPut(), CtoDAnsi() and
more.
· Added VO Compatible overload for FRead4()
· No longer (cathed) exceptions are produced for empty dates
· Ferror() was not always return the error of a file operation. This has
been fixed
· We have added a new FException() function that returns the last
exception that occurred for a low level file operation
· Casting a usual containing a PTR to a LONG or DWORD is now
supported
· Some new interfaces have been added related to array handling. The
compiler no longer inserts a cast to Array inside the code, but inserts a
cast to one of these interfaces depending on the type of the index
parameter. The USUAL type implements IIndexer and IIndexProperties
and dispatches the call to the objects inside the usual when this
objects exposes the interface. This is used for indexed access of
properties when using AEval or AScan on an ARRAY OF <type>

© 2015- 2019 XSharp BV

 X# Documentation 30

o XSharp.IIndexer
o XSharp.INamedIndexer
o XSharp.IIndexedProperties

SDK Classes
· We have added the Hybrid UI classes from Paul Piko (with permission
from Paul)

Tools
· The Vulcan XPorter now also has an option to replace the runtime and
SDK references with references to the X# runtime
Changes in 2.0.0.6 (Bandol Beta 6)

Compiler
· The compiler was sometimes still generating warnings for unused
variables generated by the compiler. This has been fixed.
· The compiler will now produce a warning that #pragmas are not
supported yet (9006)
· Added compiler macro __FUNCTION__ that returns the current
function/method name in original casing.
· Literal sub arrays for multidimensional arrays no longer need a type
prefix when compiling in the Core dialect
· Fixed problem with the Global class name that would happen when
building the runtime assemblies (these have a special convention for
the global class names)
· When the calling convention of a method in an interface is different
from the calling convention of the implementation (CLIPPER vs Not
CLIPPER) then a new error (9067) will be generated by the compiler.
· The calling convention for _DLL functions and procedures is now
optional and defaults to PASCAL (stdcall)
· The namespace alias for using statements was not working in all
cases.
· The compiler will now generate an error for code that incorrectly uses
the VIRTUAL and OVERRIDE modifiers.
· The compiler was throwing an exception for a specific kind of incorrect
local variable initializer with generic arguments. This has been fixed.
· Visibility modifiers on GET or SET accessors for properties were not
working correctly (INTERNAL, PRIVATE etc). This has been fixed.
· The compiler now handles PSZ(_CAST,...) and PSZ(..) differently.
When the argument is a literal string, then the PSZ will only be
allocated once and stored in a "PSZ Table" in your assembly. The
lifetime of this PSZ is then the lifetime of your app. When this happens
then the new compiler warning XS9068 will be shown.
When the argument is a string stored in a local or global (or define)
then the compiler can't know the lifetime of the PSZ. It will therefore
allocate the memory for the PSZ with the StringAlloc() function. This
ensures that the PSZ will not go out of scope and be freed. If you use
this a lot in your application then you may be repeatedly allocating

© 2015- 2019 XSharp BV

31 XSharp Bandol

memory. We recommend that you avoid the use of the cast and
conversion operators for PSZs and take control of the lifetime of the
PSZ variables by allocating and freeing the PSZ manually. PSZ casts
on non strings (numerics or pointers) simply call the PSZ constructor
that takes an intptr (this is used on several spots in the Win32API
library for 'special' PSZ values).
· Named arguments are now also supported in the Vulcan dialect. This
may lead to compiler errors if your code looks like the code below,
because the compiler will think that aValue is a named argument of the
Empty() function.

IF Empty(aValue := SomeExpression())

· If you were inheriting a static class from another class then you would
get a compiler warning before. This is now a compiler error, because
this had a side effect where the resulting assembly contained a
corrupted reference.
· The overload resolution code now chooses a type method/function
over a method/function with clipper calling convention.
· The XBase++ dialect is now recognized by the compiler. For the time
being it behaves the same as Harbour. We have also added the
compiler macro __DIALECT_XBASEPP__ that will be automatically
define to TRUE when compiling in Xbase++ mode.
· Fixed a problem in the PDB line number generation that would cause
incorrect line numbers in the debugger

Visual Studio integration

· The source code editor was not always showing the correct 'active'
region for #defines defined in #include files.
· Opening a source file without entities (e.g. a header file) could result in
an error message inside VS.
· Fixed a null reference exception in the editor
· Fixed a problem when un-commenting code in the editor
· Improved load time performance for large solutions with many
dependencies.
· Fixed a problem where the intellisense engine could lock a DLL that
was used by a project reference or assembly reference.
· Fixed a problem where missing references (for example COM
references that were not installed on the developers machine) could
cause problems with the type lookup when opening forms in the
windows forms editor.
· Added an option to select the Harbour dialect on the project properties
page.

The Build System

· The Build system did not recognize that begin NAMESPACE lines in
source code were commented out. This has been fixed.

© 2015- 2019 XSharp BV

 X# Documentation 32

VOXporter
· We have added an option to sort the entities in alphabetical order in the
output file.
· We have added an option so you can choose to add the X# Runtime
as reference to your application (otherwise the Vulcan runtime is used)

Runtime
· The SetCentury setting was incorrect after calling
SetInternational(#Windows). This has been fixed.
· The Descend function for dates now returns a number just like in VO
· The functions ChrA and AscA have been renamed to Chr() and Asc()
and the original functions Chr() and Asc() have been removed. The
original functions were using the DOS (Oem) codepage and this is not
compatible with Visual Objects.
· On several places in the runtime characters were converted from 8 bit
to 16 bit using the System.Encoding.Default codepage. This has been
changed. We use the codepage that matches the WinCodePage in
the Runtimestate now. So by setting the Windows codepage in the
runtime state you now also control the conversions from Unicode to
Ansi and back
· The Oem2Ansi conversion was incorrect for some low level file
functions.
· We have changed several things in the Late Binding support
· All String - PSZ routines (String2PSz(), StringAlloc() etc) now use the
Windows Codepage to convert the unicode strings to ansi.
· If you library is compiled with 'Compatible String comparisons' but the
main app isn't, then the string comparisons in the library will follow the
same rules as the main app because the main app registers the /vo13
setting with the runtime. The "compatible" stringcomparison routines
in the runtime now detect that the main app does not want to do VO
compatible string comparisons and will simply call the normal .Net
comparison routines.
We therefore recommend that 3rd party products always use the
Compatible String comparisons in their code.
· Preliminary documentation for the runtime was generated from source
code comments and has been included as chapter in this
documentation.

The VO SDK
· This build includes the first version of the VO SDK compiled against
the X# runtime. We have included the following class libraries
o Win32API
o System Classes
o RDD Classes
o SQL Classes
o GUI Classes
o Internet Classes
o Console Classes

© 2015- 2019 XSharp BV

33 XSharp Bandol

o Report Classes
· All assemblies are named VO<Name>.DLL and the classes in these
assemblies are in the VO namespace.
· This SDK is based on the VO 2.8 SP3 source code. The differences
between VO 2.8 SP3 and VO 2.8 SP4 will be merged in the source
later,
· The Libraries for OLE, OleServer and Internet Server are not included.
The OleAutoObject class and its support classes is included in the
XSharp.VO library. OleControl and OleObject are not included.
· Preliminary documentation for these classes was generated from
source code comments and has been included as chapter in this
documentation.

The RDD system

· This build includes the first version of the RDD system. DBF-DBT is
ready now. Other RDDs will follow in the next builds. Also most of the
RDD related functions are working in this build.
· This build also includes the first version of the Advantage RDD. With
this RDD you can access DBF/DBT/NTX files , DBF/FPT/CDX files
and ADT/ADM/ADI files. The RDD names are the same as the RDD
names for Vulcan. (AXDBFCDX, AXDBFNTX, ADSADT). We also
support the AXDBFVFP format and the AXSQLCDX, AXSQLNTX,
AXSQLVFP. For more information about the differences and
possibilities of these RDD look in the Advantage documentation.
We have coded the Advantage RDD on top of the Advantage Client
Engine. Our RDD system detects if you are running in x86 or x64
mode and calls functions in Ace32 or Ace64 accordingly.
To use Advantage you copy the support DLLs from an Advantage
Vulcan RDD to the folder of your application. Look at the Advantage
docs for Vulcan to see the list of the DLLs. The Advantage RDD is part
of the standard XSharp.RDD.DLL which therefore replaces the
AdvantageRDD.Dll for Vulcan.
· The XSharp.Core DLL now also has RDD support. We have chosen
NOT to implement this in functions, but as static methods inside the
CoreDb class. Old code that uses the VoDb..() functions can be
simply ported by changing "VoDb" to "CoreDb."
The parameters and return values that are USUAL in VO and Vulcan
are implemented as OBJECT in the CoreDb class.
The ..Info() methods have 2 overloads. One that takes an Object and
one that takes a reference to an object.
The methods inside CoreDb return success or failure with a logical
value like the VODB..() functions in VO. If you want to know what the
error was during the last operation then you can access that with the
method CoreDb._ErrInfoPtr() . This returns the last exception that
occurred in a RDD operation.
· At this moment the CoreDb class only has a FieldGet() that returns an
object. We will add some extra methods that return values in a
specified type in the next build (such as FieldGetString(),
FieldGetBytes() etc). We will also add overloads for FieldPut() that
take different parameter types.

© 2015- 2019 XSharp BV

 X# Documentation 34

· The XSharp.VO DLL has the VoDb..() functions and the higher level
functions such as DbAppend(), EOF(), DbSkip() etc.
The VoDb..() functions return success or failure with a logical value. If
you want to know what the error was during the last operation then you
can access that with the method _VoDbErrInfoPtr() . This returns the
last exception that occurred in a RDD operation.
· You can mix calls to the VoDb..() functions and CoreDb...() methods.
Under the hood the VoDb..() functions also call the CoreDb methods.
· The higher level functions may throw an exception just like in VO. For
example when you call them on a workarea where no table is opened.
Some functions simply return an empty value (like Dbf(), Recno()).
Others will throw an exception. When you have registered an error
handler with ErrorBlock() then this error handler will be called with the
error object. Otherwise the system will throw an exception.
· Date values are returned by the RDD system in a DbDate structure,
Float values are returned in a DbFloat structure. These structures
have no implicit conversion methods. They do however implement
IDate and IFloat and they can and will be converted to the Date and
Float types when they are stored in a USUAL inside the XSharp.VO
DLL. The DbDate structure is simply a combination of a year, month
and date. The DbFloat structure holds the value of fields in a Real8,
combined with length and the number of decimals.
· More documentation about the RDD system will follow later. Of course
you can also look at the help file and source code on GitHub.
Changes in 2.0.0.5 (Bandol Beta 5)

Compiler
· The strong named key for assemblies with native resources was
invalid. This has been fixed
· When an include file was included twice for the same source (PRG)
file then a large number of compiler warnings for duplicate #defines
would be generated. Especially when the Vulcan
VOWin32APILibrary.vh was included twice then over 15000 compiler
warnings would be generated per source file where this happened.
This large number of warnings could lead to excessive memory usage
by the compiler. We are now outputting a compilation error when we
detect that the same file was included twice. We have also added a
limit of 500 preprocessor errors per source (PRG) file.
· A change in Beta 4 could result in compiler warnings about unused
variables that were introduced automatically by the X# compiler. This
warning will no longer be generated.
· The compiler now correctly stores some compiler options in the
runtime state of XSharp.

Runtime
· Fixed a problem in the Ansi2OEM and OEM2Ansi functions.
· Fixed a problem in the sorting for SetCollation(#Windows)
· Fixed a problem with string comparisons in runtime functions like
ASort(). This now also respects the new runtime property
CompilerOptionVO13 to control the sorting

© 2015- 2019 XSharp BV

35 XSharp Bandol

Visual Studio integration

· The sorting of the members in the editor dropdown for members was
on methodname and propertyname and did not include the typename.
When a source file contained more than one type then the members
would be mixed in the members dropdown

Build System
· The default value for VO15 has been changed back from false to
undefined.
Changes in 2.0.0.4 (Bandol Beta 4)

Compiler
· POSSIBLY BREAKING CHANGE: Functions now always take
precedence over same named methods. If you want to call a
method inside the same class you need to either prefix it with the
typename (for static methods) or with the SELF: prefix. If there is no
conflicting function name then you can still call the method with just its
name. We recommend to prefix the method calls to make your code
easier to read.
· The compiler was accepting just an identifier without a INSTANCE,
EXPORT or other prefix and without a type inside a class declaration.
It would create a public field of type USUAL. That is no longer possible.
· Improved the positional keyword detection algorithm (this also affects
the source code editor)
· The || operator now maps to the logical or (a .OR. b) and not to the
binary or (_OR(a,b))
· The VAR statement now also correctly parses

VAR x = SomeFunction()

And will compile this with a warning that you should use the
assignment operator (:=).
We have added this because many people (including we) copy
examples from VB and C# where the operator is a single equals token.
· Error messages about conflicting types now include the fully qualified
type name.
· The compiler no longer includes the width for literal Floats. This is
compatible with VO.
· A Default parameter of type Enum is now allowed.

Runtime
· Added several functions that were missing, such as __Str() and
DoEvents()
· Fixed a problem in the macro compiler with non-english culctures.
· Added several overloads for Is..() functions that take a PSZ instead of
a string, such as IsAlpha() and IsUpper().

© 2015- 2019 XSharp BV

 X# Documentation 36

· Added some missing error defines, such as E_DEFAULT and

E_RETRY.
· Fix for a problem with SubStr() and a negative argument
· Fix for a problem with IsInstanceOf()
· Fix for a problem with Val() and a hex value with an embedded 'E'
character
· Added implicit conversions from ARRAY to OBJECT[] and back.
· Several changes to the code for Transform() and Unformat() to cover
several exotic picture formats
· Changes to the code for SetCentury() to automatically also adjust the
date format (SetDateFormat())
· Fixes for the Str() family of functions in combination with SetFixed()
and SetDigitFixed().

Visual Studio integration

· Fixed a problem when building projects in the latest build of Visual
Studio
· Several 'keywords' were not case synchronized before, such as
TRUE, FALSE, NULL_STRING etc,
· Keywords are not case synchronized on the current line as long as the
user has the cursor on them or immediately after them. That means
that when you type String and want to continue to change it to
StringComparer then the formatter will no longer kick in and change
"String" to the keyword case before you have the chance to complete
the word.
· The Control Order dialog inside the form editor was not saving its
changes.
· Added an option to include all entities from the editor, or just the
members from the current selected type in the right dropdown of the
editor
· The editor was also matching braces inside literal strings and
comments. This has been fixed.
· Fixed a problem with the CodeDom parser where extended strings
(strings containing CRLF tokens or other special tokens) were parsed
incorrectly. This resulted in problems in the windows forms editor.
· The member resolution code in the editor was not following the same
logic as the compiler: When a function and a method with the same
name exist it was resolving to the method in stead of the function. This
has been fixed.
· Fixed a problem when debugging in X64 mode.
· Fixed an exception when comparing source code files with SCC
integration.
· Fixed several problems w.r.t. the XAML editor:
o Code is now generated with STRICT calling
convention to avoid problems when compiler option
"Impliciting CLIPPER calling convention" is enabled
o WPF and other templates now include STRICT
calling convention for the same reason
o The XAML editor could not properly load the current
DLL or EXE and had therefore problems resolving

© 2015- 2019 XSharp BV

37 XSharp Bandol

namespaces and adding user controls to the tool

palette. This has been fixed.
· We have added an option to the Tools/Editor/XSharp/Intellisense
options that allow you to control how the member combobox in the
editor works. You can choose to only show methods & properties of
the current type or all entities in the right combobox. The left combobox
always shows all types in the file.
· Some of the project and item templates have been updated. Methods
and constructors without parameters now have a STRICT calling
convention. Also the compiler option /vo15 has been explicitly disabled
in templates for the Core dialect.
Changes in 2.0.0.3 (Bandol Beta 3)

Compiler
· When 2 method overloads have matching prototypes the compiler now
prefers the non generic one over the generic one
· Fixed an exception that could occur when compiling a single line of
source code with a preprocessor command in it.

Runtime
· Added Mod() function
· Added ArrayNew() overload with no parameters
· Fixed problem in __StringNotEquals() when length(RHS) >
length(LHS) and SetExact() == FALSE
· Added missing string resource for USUAL overflow errors

Visual Studio integration

· Improved keyword case synchronization and indenting. Also a source
file is 'Keyword Case' synchronized when opened.
· Opening a source file by double clicking the find results window no
longer opens a new window for the same source file
· Improved type lookup speed for intellisense
· Fixed a problem that would prevent type lookup for types in the same
namespace
· Fix for QuickInfo problem introduced in the latest Visual Studio 2017
builds
· QuickInfo tips are no longer shown in the debugger where they were
overlapping with debugger tooltips
· The comboboxes with methods and functions in the editor window no
longer shows parameter names and full type names. Now it shows the
shortened type names for the parameters
· These same comboboxes now show the file name for methods and
properties defined in another source file
· Fixed problem in the window editor with generating code for tab pages

Vulcan XPorter
· Project dependencies defined in the solution file were not properly
converted

© 2015- 2019 XSharp BV

 X# Documentation 38

VO XPorter
· Fixed a problem where resource names were replaced with the value
of a define
Changes in 2.0.0.2 (Bandol Beta 2)

Compiler
· The compiler now transparently accepts both Int and Dword
parameters for XBase Array indices
· When the compiler finds a weakly typed function in XSharp.VO and a
strongly typed version in XSharp.Core then it will choose the strongly
typed version in XSharp.Core now.
· In the VO and Vulcan dialect sometimes an (incorrect) warning
'duplicate usings' was displayed. This is now suppressed.
· The debugger information for the Start function has been improved to
avoid unnecessary step back to line 1 at the end of the code
· The debugger break point information for BEGIN LOCK and BEGIN
SCOPE has been improved
· The debugger break point information for multi line properties has been
improved
· /vo6, /vo7 and /vo11 are now only supported in the VO/Vulcan dialect

Runtime
· Removed DWORD overloads for Array indexers
· Fixed overload problem for ErrString()
· Fixed overload problem for _DebOut()
· Fixed problems in DTOC() and Date:ToString()
· Fixed ASort() incompatibilities with VO
· Fixed memory blocks now get filled with 0xFF when they are released
to help detect problems

Visual Studio
· Fix 'Hang' in VS2017 when building
· Fix 'Hang' in VS2017 when a tooltip (QuickInfo) was displayed
· Fixed problem with debugging x64 apps
· You can no longer rename or delete the Properties folder
· Selecting 'Open' from the context menu on the the Properties folder
now opens the project properties screen
· Updated several icons in the Project Tree
· Enhancements in the Goto Definition

Build System
· Fix problem with CRLF in embedded resource commandline option

© 2015- 2019 XSharp BV

39 XSharp Bandol

Changes in 2.0.0.1 (Bandol Beta 1)

Compiler

New features
· Added support for ARRAY OF language construct. See the Runtime
chapter for more information about this.
· Added support for the X# Runtime assemblies when compiling in the
VO or Vulcan dialects.
· Added support for the "Pseudo" function ARGCOUNT() that returns the
# of declared parameters in a function/method compiled with clipper
calling convention.
· Added a new warning number for assigning values to a foreach local
variable. Assigning to USING and FIXED locals will generate an error.

Optimizations
· Optimized the code generation for Clipper calling convention
functions/methods
· The /cf and /norun compiler options are no longer supported
· The preprocessor no longer strips white space. This should result in
better error messages when compiling code that uses the
preprocessor.
· Some parser errors are now more descriptive
· Changed the method that is used to determine if we compile against
CLR2 or CLR4. The compiler checks at the location either system.dll
or mscorlib.dll. When this location is in a path that contains "v2", "2.",
"v3" or "3." then we assume we are compiling for CLR2. A path that
contains "V4" or "4." is considered CLR4. The /clr commandline option
for the compiler is NOT supported.
· The preprocessor now generates an error when it detects recursive
#include files.

Bug fixes
· Fixed a problem when using the [CallerMemberAttribute] on
parameters when compiling in Vulcan or VO Dialect
· Abstract properties should no longer generate a warning about a body
· You can now correctly use ENUM values as array indexes.
· Fixed a problem for Properties with PUBLIC GET and PRIVATE SET
accessors.
· Fixed an issue where assigning an Interface to a USUAL required a
cast to Object
· Fixed an issue where IIF expressions with literal types were returning
the wrong type (the L or U suffix was ignored)
· Fixed an issue where the declaration LOCAL x[10] was not compiled
correctly. This now compiles into a local VO Array with 10 elements.

© 2015- 2019 XSharp BV

 X# Documentation 40

Visual Studio Integration

· Build 1.2.1 introduced a problem that could cause output files to be
locked by the intellisense engine. This has been fixed
· The editor parser had problems with nested types. This has been fixed
· Enum members were not included in code completion for enums
inside X# projects
· Some improvements in the code reformatting
· Added option on the Tools/Options for the editor to include keywords in
the "All tokens" completion list
· Fixed a problem where assemblies that could not be loaded to retrieve
meta information would be retried 'for ever'
· Fixed a problem with retrieving type information from assemblies that
contained both managed and unmanaged code.
· Added some properties for referenced assemblies to the IDE
Properties window
· Fixed a problem with assembly references and the Windows Forms
editor, introduced in one of the latest Visual Studio 2017 updates
· When enabling XML output on the Project Properties window an
incorrect filename was shown for assemblies that contain a '.'in the
assembly name.
· The editor parser now has better support for parameters of type REF
and OUT
· Added support for 'Embed Interop Types' in the property windows for
Assembly References and COM references
· Fixed a problem where the codemodel was sometimes locking output
DLLs for Project references
Build System
· Fixed a problem with the naming of the XML documentation file.

Runtime
· Added XSharp.Core.DLL, XSharp.VO.DLL and
XSharp.Macrocompiler.DLL.
Most runtime functions are implemented and supported. See the X#
Runtime chapter for more information

VO XPorter
· SDK related options have been removed. They will be moved to a new
tool later.
Changes in 1.2.1

Compiler
· Fixed a problem where a compilation error resulted in the message
"Failed to emit module" without further information
· Fixed a problem with ++, -- += and similar operations in aliased
expressions (like CUSTOMER->CUSTNO++)

© 2015- 2019 XSharp BV

41 XSharp Bandol

· Constructor initializers and Collection initializers were not working after

a constructor with parameters. That has been fixed.
· Fixed an issue with negative literal values stored in a USUAL when
overflow checking was enabled.
· For the CATCH clause now both the ID and the TypeName are
optional. This means that there are 4 variations.
You can only have one catch clause without type, since this defaults to
the System.Exception type. However, you can have many catch
clauses without ID.

CATCH ID AS ExceptionType
CATCH ID // defaults to Exception type
CATCH AS ExceptionType
CATCH // defaults to Exception type

Visual Studio Integration

· Improved the speed of the background code scanning
· Improved the speed of the background parser inside the editor
· Fixed a problem in the codedom provider that is used by the windows
forms editor
Changes in 1.2.0

Compiler
· You can now pass NULL for parameters declared by reference for
compatibility with VO & Vulcan.
We STRONGLY advise not to do this, unless you make sure that the
function expects this and does not assign to the reference parameter
without checking for a NULL reference first. This will only work when
the /vo7 compiler option is enabled.
· We have made some optimizations in the Lexer. The compiler should
be a little faster because of that
· We fixed a problem with the automatic constructor generation (/vo16)
for classes that inherit from classes defined in an external DLL
· When compiling with /vo2 any string fields assigned in a child class
before the super constructor was called would be overwritten with an
empty string. The generated code will now only assign an empty string
when the string is NULL.
Note: we do not recommend to assign parent fields in the child
constructor before calling the super constructor. Manually coded
default values for parent fields will still overwrite values assigned in the
child constructor before the SUPER call
· Fixed a problem with CHECKED() and UNCHECKED() syntax in the
VO dialect
· Fixed a problem with choosing overloads for methods where an
overload exists with a single object parameter and also an overload
with an object[] parameter.
· Added support to the parser for LOCAL STATIC syntax

© 2015- 2019 XSharp BV

 X# Documentation 42

· Fixed a problem with compiler option /vo9 (Allow missing return

values) and procedures or methods that return VOID
· Improved debugger sequence point generation. The compiler no longer
generates 'hidden' breakpoint information for startup and closedown
code in the VO/Vulcan dialects, and for expression statements no
longer a double step is necessary.
· ACCESS and ASSIGN for partial classes could generate error
messages without source file name. This has been solved.
The compiler now generates slightly different code for these "partial"
properties.
The Access and Assign are implemented as compiler generated
methods and the property getter and property setter now call these
methods.
· The compiler was not recognizing the _WINCALL calling convention.
This has been fixed.
· The compiler now generates a warning when the #pragma command
is used

Visual Studio Integration

· More performance improvements in the editor. Especially large source
files with incorrect code could slow down the editor.
· The editor parser no longer tries to parse include files repeatedly when
these files contain #defines only (like the Vulcan header files)
· The source code editor tried to show intellisense for words in a
comment region. That has been fixed.
· We have started work on Object Browser and Class Browser.
· Opening and closing of projects should be slightly faster
· The internal code model used by the editors now disposes its loaded
information when projects are closed and no projects need this
information anymore. This should reduce the memory usage of the X#
project system
· Matching keywords, such as IF .. ENDIF and FOR .. NEXT should now
be highlighted in the editor
· If you select an identifier in the editor then that identifier will be
highlighted in the current method/function on all places where it is used
· We have added several features that you need to enable/disable on
the Tools/Options/Text Editor/XSharp/Intellisense dialog:
o The code completion in the editor also supports
instance member completion when a dot is
pressed.
Please note that the compiler ONLY accepts this in
the Core language, not in the VO & Vulcan dialect.
So the option has no effect inside projects with
other dialects.
o We have added some options to control the sorting
of the DropDown comboboxes in the editor, as well
as if fields/instance variables should be included in
these comboboxes. When you do not sort, then the
entries in the dropdown box will be shown in the
order in which they are found in the source file.

© 2015- 2019 XSharp BV

43 XSharp Bandol

o We have added the option to autocomplete

identifiers when typing. This includes locals,
parameters, class fields, namespaces, types etc.
· Overridden methods in subclasses with the same signature as the
parent methods they override are no longer counted as overloads in
completionlists
· A missing reference DLL could "kill" the intellisense engine. This no
longer happens. Of course the type info from a missing referenced
DLL is not included.
· Properties and methods in the generated source files for XAML code
(the .g.prg files in the OBJ folder) are now also parsed and included in
the completion lists in intellisense and in the Class Browser and
Object Browser windows.

VOXPorter
· The installer now includes the correct version of VOXPorter <g>
· VOXporter now supports the following commandline options:
/s:<source folder or aef>
/d:<destination folder>
/r:<runtime folder>
/nowarning

· Some code corrections were added for issues found in the GUI
classes
· The template files can now also be found when VOXPorter is run from
a different working directory
Changes in 1.1.2

Compiler
· Added compiler warning for code that contains a #pragma
· Fixed a problem with iif() functions and negative literal values

Visual Studio Integration

· Fixed a slowness in the editor after typing a send (: ) operator
· Enum values are now properly decoded in the debugger
· Fixed the CodeDom provider for handling literal FALSE values and
negative numbers. As a result, more (Vulcan created) winforms should
open without problems
· Some positional keywords (such as ADD and REMOVE) are no longer
colored as keyword in the editor for incomplete code when they appear
after a colon ‘:’ or dot ‘.’;

VOXPorter
· Fixes for exporting the VO RDD Classes from the SDK

© 2015- 2019 XSharp BV

 X# Documentation 44

Changes in 1.1.1

Compiler
· Fixed a problem with Debugger Breakpoints for DO CASE and
OTHERWISE
· Fixed a problem with Debugger Breakpoints for sourcecode that is
defined in #included files
· Added support for the Harbour Global Syntax where the GLOBAL
keyword is optional
· Fixed a problem with FOR.. NEXT loops with negative step values
· In some situations the @@ prefix to avoid keyword conflicts was not
removed from workarea names or field names. This has been fixed
· In the VO/Vulcan dialect a warning (XS9015) was generated when a
default parameterless SUPER constructor call was automatically
generated. This error message is now suppressed. However a
generated SUPER constructor call with parameters still generates a
warning.
· Prepared the compiler for Xbase type names and function names in
the XSharp Runtime

Preprocessor
· Fixed a crash in the preprocessor
· The preprocessor was generating an error "Optional block does not
contain a match marker" for blocks without match marker. This is now
allowed.
(for example for the ALL clause in some of the Database UDCs )
· When the same include files was used by multiple source files, and
different sections of this file were included because of different #ifdef
conditions, then the preprocessor would get "confused". This has been
fixed.
· Debugger file/line number information from source code imported from
#include files is not processed correctly.

Visual Studio Integration

· Fixed several issues with the Windows Form Editor
· The class declaration generated by the VO compatible editors now
included the PARTIAL modifier.

Changes in 1.1

Compiler
· Fixed a problem with Codeblocks used in late bound code after the
release of X# 1.0.3
· Fixed a problem with overriding properties in a subclass that inherit
from a class where only the Assign (Set) or Access (Get) are defined.
· The compiler option /vo16: automatically generate VO Clipper
constructors has been implemented.

© 2015- 2019 XSharp BV

45 XSharp Bandol

· Fixed a crash in the compiler for compiler errors that occur on line 1,
column 1 of the source file
· Fixed a problem where overflow checking was not following the /ovf
compiler option
· Fixed problem with public modifier for interface methods
· Added proper error message with unreachable fields in external DLLs
· Fixed a problem with debugger sequence points (debugger stepping)
· X# generated pdb files are now marked with the X# language GUID so
they are recognized as X# in the VS debugger
· DATETIME (26) and DECIMAL (27) are added as UsualType to the
compiler in preparation of the X# runtime that allows usuals of these
types
· Compiler options /VO15 and /VO16 now produce an error message
when used outside the VO/Vulcan dialect
· Methods declared outside a class (VO style code) would declare a
private class and not a public class
· ASTYPE has been changed to a positional keyword
· Fixed a problem with the Chr() and _Chr() functions for literal numbers
> 127
· Added support for the __CLR2__ and __CLR4__ compiler macros.
The version is derived from the folder name of mscorlib.dll and/or
system.dll
· The Codeblock syntax was not working in the Core dialect.
· Some new keywords, such as REPEAT, UNTIL, CATCH,
FINALLY,VAR, IMPLIED, NAMESPACE, LOCK, SCOPE, YIELD,
SWITCH etc are now also positional and will only be recognized as
keyword when at the start of a line or after a matching other keyword.
This should help prevent cryptic error messages when these
keywords are used as function names.

Visual Studio

Source code editor

· Added Goto Definition for Functions and Procedures
· Improved Info tips for Functions and Procedures
· Improved case synchronization
· Added first version of smart indenting
· Fixed lookup problems in the intellisense engine that could lock up VS
· Compiler Generated types are now suppressed from the completion
lists.
· Added partial support for intellisense for LOCAL IMPLIED and VAR
variables
· Added support for Format Document. This also sets the case for
identifiers according to the tools defined in the Tools/Options menu
· Performance improvements for the background file scanner. This
scanner is also paused during the build process to improve the
compilation speed.

© 2015- 2019 XSharp BV

 X# Documentation 46

Project System and MsBuild

· Fixed a problem in the project files with conditioned property groups.
Existing projects will be updated automatically
· Added support for the /vo16 compiler option in MsBuild and the VS
Project Property pages.
· Fixed a problem with the /nostddef compiler option which was not
working as expected.
· Fixed a problem which would occur when entering resources or
settings in the project property dialog
· Fixed a problem with the /nostdlib compiler option
· License.Licx files are now added as "Embedded Resource"
· Fixed a problem with the automatic adding of License files
· When a project has a "broken reference" and a new reference is
added with the correct location, then the broken reference will be
deleted and the new references will be added instead.
· The MSBuild support DLL was unable to find the location of the
compiler and native resource compiler when running inside a 64 bit
process

Form Editor
· Improved Windows Form Editor support for types defined in project
references. We will now detect the location of the output files for these
projects, like the C# and VB project systems.
· The Code parser for the Form Editor was having problems with
untyped methods. This has been fixed.

VO Window and Menu Editor

· The code generator for the Window and Menu editor will delete old
unused defines.
· Changed the item template for VO windows to fix a problem when
adding an event handler to a window that has not been saved yet
· The code generator for the Window editor was not outputting a style
for WS_VISIBLE. This has been fixed.

Debugger
This build introduces a first version of the XSharp debugger support
· The Visual Studio debugger now shows the language X# in the
callstack window and other places
· Functions, Methods and procedures are now displayed in the X#
language style in the callstack window
· Compiler generated variables are no longer shown in the locals list
· The locals list now shows SELF in stead of this
· X# predefined types such as WORD, LOGIC etc are shown with their
X# type names in the locals window

Testing
· Added support for the Test Explorer window

© 2015- 2019 XSharp BV

47 XSharp Bandol

· Added templates for unit testing with XUnit, NUnit and Microsoft Test

Other
· Added warning when Vulcan was (re)installed after XSharp, which
could cause a problem in the Visual Studio integration
· The VS Parser was marking Interfaces as structure in stead of
interface. This has been fixed.
· The tool XPorter tools have better names in the VS Tools Menu
· The VS Background parser gets suspended while looking up type
information to improve the intellisense speed
· Several changes were made to the templates that come with X#

XPorter
· Fix problem in propertygroup conditions.

VOXPorter
· Generate clipper constructors is now disabled by default
· Fixed a problem in the VS Template files.

Changes in 1.0.3

Compiler
· Fixed a problem with the index calculation for Vulcan Arrays indexed
with a usual argument
· Fixed a problem with the generation of automatic return values for
code that ends with a begin sequence statement or a try statement
· Optimized the runtime performance for literal symbols.
The compiler now generates a symbol table for the literal symbols and
each literal symbol used in your app is only created once.
You may experience a little delay at startup if your app uses a LOT
(thousands) of literal symbols. But the runtime performance should be
better.
· Added a compiler error for code where numerics are casted to an
OBJECT with the VO compatible _CAST operator.
This is no longer allowed:
LOCAL nValue as LONG
LOCAL oObject as OBJECT
nValue := 123
oObject := OBJECT(_CAST, nValue)

Changes in 1.0.2

Compiler
· Added support for XML doc generation. We support the same tags that
the C# compiler and other .Net compiler support.
· Improved some parser errors.

© 2015- 2019 XSharp BV

 X# Documentation 48

· Created separate projects for portable and non portable (.Net

framework 4.6) for the compiler and scripting
· Fixed the code generation for conversion from USUAL to a known type.
Now the same error is generated that Vulcan produces when the
object type in the usual does not match the type of the target variable
· When declaring a type with the same name as the assembly now a
compiler error is generated with a suggested work around.
· Fixed a strange compiler message when using a PTR() operation on a
method call
· Indexed access to bytes in a PSZ is now 1 based like in VO when the
VO dialect is used. The Vulcan dialect needs 0 based index access
like Vulcan.
· The error message for compound assignments of FLOAT and USUAL
has been removed. The compiler now contains a workaround for the
problem in the Vulcan Runtime
· For ambiguous code where the compiler has to choose between a
Function call and a static method call in any other class, the compiler
now chooses the function call over the method call (Vo and Vulcan
dialect). The warning will still be generated.
· When passing a variable by reference with the @ sign the compiler will
now check to see if the declared type of the function/method
parameter matches the type of the local variable.
· Some compiler warnings for unused variables were being suppressed
in the VO/Vulcan dialect. They are activated again.

Scripting
· The scripting was not working in release 1.01

Visual Studio Integration

· QuickInfo could generate a 'hang' in the VS editor. This has been fixed
· Added quickinfo for globals and defines
· Added completionlists for globals and defines
· Added VO Form editor to edit vnfrm/xsfrm files and generate the code
and resources
· Added VO Menu editor to edit vnmnu/xsmnu files and generate the
code and resources
· Added VO DbServer editor and VO Fieldspec editor to edit
vndbs/xsdbs and vnfs/xsfs files and generate the code and resources
· Added keyword and identifier case synchronization.
· Fixed a problem where typing SUPER( in the editor could throw an
exception
· Prebuild and Postbuild entries in the project file are now configuration
specific
· Added support for XML Doc generation in the project system
· Fixed a 'hang' that could occur with Visual Studio 2017 version 15.3
and later

© 2015- 2019 XSharp BV

49 XSharp Bandol

VO Xporter
· Fixed a problem when importing certain VO 2.7 AEF files
· Fixed a problem with acceptable characters in the solution folder name
· VO Form and menu entities are also included in the xsproj file
· Added an option to the INI files to specify the Vulcan Runtime files
location ( )

Changes in General Release (1.0.1.1)

Compiler
· Fixed a problem with VERY old versions of the Vulcan Runtime
· Variables declared as DIM Byte[] and similar are now Pinned by the
compiler
· [Return] attribute was not properly handled by the compiler. This has
been fixed
· Compound Assignment (u+= f or -=) from USUAL and FLOAT were
causing a stackoverflow at runtime caused by a problem in the Vulcan
Runtime. These expressions now generate a compiler error with the
suggestion to change to a simple assignment ( u := u + f)

Visual Studio Integration

· Project References between XSharp Projects were also loaded as
assemblyreference when resolving types. This could lead to speed
problems and unnecessary memory usage
· Improved the speed of the construction of Completion Lists (such as
methods and fields for a type).
· We have also added Completion List Tabs, where you can see fields,
properties, methods etc. on separate tabs. You can enable/disable this
in the Tools/Options/Text Editor/XSharp/Intellisense options page.

VO XPorter
· We have added a check to make sure that the default namespace for
a X# project cannot contain a whitespace character

Changes in General Release (1.0.1)

New Features
· We have added support for ENUM Basetypes (ENUM Foo AS WORD)
· We have added a separate syntax for Lambda Expressions
· We have added support for Anonymous Method Expressions
· Typed local variables can now also be used for PCALL() calls
· Methods with the ExtensionAttribute and Parameters with the
ParamArrayAttribute attributes now compile correctly, but with a
warning

© 2015- 2019 XSharp BV

 X# Documentation 50

Compiler
· Fixed a problem with a late bound assign of a literal codeblock
· Resolved several name conflicts
· Improved several of the error messages
· Fixed compilation problem for Properties with only a SET accessor
· Fixed a crash in a switch block with an if .. endif statement
· Fix problem with virtual instance methods and structures
· Fixed name conflict foreach variables used in Array Literals
· Changed resolution for Functions and static methods with the same
name.
In the VO/Vulcan dialect functions take precedence over static
methods. If you want to call the static method then then you need to
prefix the method call with the classname.
· There is a separate topic in this documentation now that describes the
syntax differences and similarities between Codeblocks, Lambda
Expressions and Anonymous Method Expressions.
· Fixed incorrect error message for Start() function with wrong
prototype.
· When an ambiguity is detected between a function and a static
method then a warning is displayed

Visual Studio
· Added parameter tips for Functions and methods from "Using Static"
classes
· Added parameter tips for Clipper Calling Convention functions and
methods
· Added support for generics in Intellisense
· Intellisense will show keywords in stead of native type names (WORD
in stead of System.UInt16 for example)
· Parameter tips are now shown when a opening '(' or '{' is typed as
well as when the user types a comma ','.
· Parameter tips will show REF OUT and AS modifiers
· Added intellisense for COM references, both for normal COM
references as well as for Primary Interop Assemblies. Also members
from implemented interfaces are now included in intellisense code
completion (this is very common for COM).
· Improved intellisense for Project References from other languages,
such as C# and VB.
· Added intellisense for Functions in referenced projects and referenced
Vulcan and/or X# assemblies
· Suppress "special type names" in intellisense lists
· Added support for "VulcanClassLibrary" attribute to help find types and
functions
· Errors from the Native Resource compiler are now also included in the
error list
· Fixed problem with parameter tips for Constructors
· Added memberlist support for X# type keywords such as STRING,
REAL4 etc.

© 2015- 2019 XSharp BV

51 XSharp Bandol

· Fixed several issues with the Windows Form editor in relation to

ActiveX controls
· Added a menu option to start the VO Xporter tool
· Added background scanning for dependent items, to make sure that
newly generated code is scanned and available for intellisense.
· Several changes to the Windows Forms editor and project system:
o Added support for adding ActiveX controls
o Added support for Form Inheritance. Our forms are
also visible in the C# Inherited form wizard
o Added support to add our Windows Forms Custom
Controls to the ToolBox in Visual Studio
o Some performance enhancements in the
Codedom Parser that is used by the Windows
Form Editor. You should notice this for larger
forms.
· Fixed several crashes reported by users
· Native Resource files (.rc) now open in the Source code editor
· Improved background parsing speed
· Improved keyword colorization speed
· Improved handling of Type and Member dropdowns in the editor

Tools
· Added a first version of the VO Xporter tool
· The installer now registers .xsproj files, .prg, .ppo. .vh, .xh and .xs files
so they will be opened with Visual Studio

Documentation
· We have added some chapters on how to convert your VO AEF and/or
PRG files to a XIDE project and/or a Visual Studio solution.

Changes in 0.2.12

Scripting
· We have added the ability to use X# scripts. Some documentation about how this works
can be found here. You can also find scripting examples in the
c:\Users\Public\Documents\XSharp\Scripting folder

Compiler

All dialects
· The compiler is now based on the Roslyn source code for C# 7.
· Accesses and Assigns with the same name for the same (partial)
class in separate source files are now merged into one property. This
will slow down the compiler somewhat. We recommend that you
define the ACCESS and ASSIGN in the same source file.
· Added support for repeated result markers in the preprocessor

© 2015- 2019 XSharp BV

 X# Documentation 52

· We have added the compiler macro __DIALECT_HARBOUR__

· Fixed the name resolution between types, namespaces, fields,
properties, methods, globals etc. The core dialect is very close to the
C# rules, the other dialect follows the VO rules.
· Some warnings for ambiguous code have been added
· _Chr() with untyped numeric values would crash. This has been fixed.
· We made some changes to the character literal rules. For the VO and
Harbour dialect there are now other rules then for Core and Vulcan.
See the help topic for more information

VO and Vulcan Dialect

· Several VO compatibility issues have been fixed
· The QUIT, ACCEPT, WAIT, DEFAULT TO and STORE command are now removed
from the compiler and defined in our standard header file "XSharpDefs.xh" which is
located in the \Program Files(x86)\XSharp\Include folder. These commands are not
compiled in the core dialect
· Added support for CONSTRUCTOR() CLASS MyClass and DESTRUCTOR CLASS
MyClass (in other words, outside the CLASS .. ENDCLASS construct
· The # (not equal) operator is now recognized when used without
space before the keywords NIL, NULL_STRING, NULL_OBJECT etc.
so #NIL is not seen as the symbol NIL but as Not Equal To NIL
· SizeOf and _TypeOf were special tokens in VO and could not be
abbreviated. We have changed the X# behavior to match this. This
prevents name conflicts with variables such as _type.
· We have added support for DLL entrypoints with embedded @ signs,
such as "CAVOADAM.AdamCleanupProtoType@12"
· (DWORD) (-1) would require the unchecked operator. This is now
compatible with Vulcan and generates a DWORD with the value
System.Uint32.MaxValue.
· STATIC VOSTRUCT now gets compiled as INTERNAL VOSTRUCT.
This means that you cannot have the same structure twice in your
app. Why would you want to do that ?
· Fixed several cases of "incorrect" code that would be compiled by VO,
such as a codeblock that looks like:
cb := { |x|, x[1] == 1 }
Note the extra comma.
This now compiled into the same codeblock as:
cb := { |x| x[1] == 1 }
· The /vo16 compiler option has been disabled for now (does not do
anything) because it had too many side effects.

Visual Studio Integration

· Deleted files and folders are moved them to the Trash can.
· Fixed an intellisense problem in the XAML editor
· Added support for Code Completion between different X# projects
· Added support for Code Completion and other intellisense features for
source code in VB and C# projects
· Added support for parameter info

© 2015- 2019 XSharp BV

53 XSharp Bandol

Documentation
· We have added (generated) topics for all undocumented compiler
errors. Some topics only contain the text that is shown by the
compiler. More documentation will follow. Also some documentation
for the X# Scripting has been added.

Changes in 0.2.11

Compiler

All dialects
· Improved some error messages, such as for unterminated strings
· Added support for the /s (Syntax Check only) command line option
· Added support for the /parseonly command line option which is used
by the intellisense parser
· Added some compiler errors and warnings for invalid code
· The preprocessor did not properly handle 4 letter abbreviations for
#command and #translate. This has been fixed
· Fixed some problems found with the preprocessor
· We switched to a new Antlr parser runtime. This should result in
slightly better performance.
· Changed the way literal characters and strings are defined:
o In the Vulcan dialect a literal string that is enclosed
with single quotes is a char literal. Double quotes
are string literals
o In the Core and VO dialect a literal string that is
enclosed with single quotes is a string literal.
Double quotes are also string literals.
To specify a char literal in Core and VO you need
to prefix the literal with a 'c':

LOCAL cChar as CHAR

cChar := c'A'

· Changed the way literal characters and strings are defined:

· sizeof() and _sizeof() no longer generate a warning that they require
'unsafe' code, when compiling for x86 or x64. When compiling for
AnyCpu the warning is still produced.
· When the includedir environment variable was not set then the
XSharp\Include folder would also not be found automatically.

VO/Vulcan Compatibility
· Added /vo16 compiler option to automatically generate constructors
with Clipper calling convention for classes without constructor

© 2015- 2019 XSharp BV

 X# Documentation 54

Harbour Compatibilty
· Started work on the Harbour dialect. This is identical with the
VO/Vulcan dialect. The only difference so far is that the IIF()
expressions are optional

Visual Studio

New features / changed behavior:

· Added Brace Matching
· Added Peek definition (Alt-F12)
· All keywords are not automatically part of the Completionlist
· Fixed a member lookup problem with Functions and Procedures inside
a Namespace
· Increased background parser speed for large projects
· Fixed type lookup for fields and properties from parent classes
· Fixed problem where CSharp projects could not find the output of a
XSharp project reference
· The Intellisense parser now properly used all current projects compiler
options.
· Prevent crashes when the X# language buffer is fed with "garbage"
such as C# code

Installer
· The local template cache and components cache for VS2017 was not
cleared properly this has been fixed.
· Added code to properly unregister an existing CodeDomProvider when
installing

Documentation
· Several empty chapters are now hidden.
· Added description of the templates

Changes in 0.2.10
This build focuses on the last remaining issues in the VO and Vulcan compatibility and
adds a lot of new features to the Visual Studio integration.

Compiler

VO/Vulcan Compatibility
· We have completed support for the DEFINE keyword. The type clause
is now optional. The compiler will figure out the type of the define when
no type is specified.
The DEFINEs will be compiled to a Constant field of the Functions
class, or a Readonly Static field, when the expression cannot be
determined at compile time (such as for Literal dates or symbols).

© 2015- 2019 XSharp BV

55 XSharp Bandol

· We have extended the preprocessor . It now has support for

#command, #translate, #xcommand and #xtranslate. Also "Pseudo
function" defines are supported, such as :

#define MAX(x,y) IIF((x) > (y), (x), (y))

This works just like a #xtranslate, with the exception that the define is
case sensitive (unless you have enabled the "VO compatible
preprocessor" option (/vo8).
The only thing that is not working in the preprocessor is the repeated
result marker.
· In VO/Vulcan mode the compiler now accepts "garbage" between
keywords such as ENDIF and NEXT and the end of the statement, just
like the VO compiler.
So you no longer have to remove "comment" tokens after a NEXT or
ENDIF. This will compile without changes in the VO and Vulcan
dialect:

IF X == Y
DoSomething()
ENDIF X == Y
or
FOR I := 1 to 10
DoSomething()
NEXT I
We do not recommend this coding style, but this kind of code is very
common...
· Fixed an issue with recognition of single quoted strings. These were
always recognized as CHAR_CONST when the length of the string
was 1. Now they are treated as STRING_CONST and the compiler
backend has been adjusted to convert the STRING literals to CHAR
literals when needed.
· In VO and Vulcan dialect when the compiler option /vo1 is used then
RETURN statements without value or with a return value of SELF are
allowed for the Init() and Axit() methods. Other return values will trigger
a compiler warning and will be ignored.

New features / changed behavior:

· The compiler now produces an error when a source file ends with an
unterminated multi line comment
· Added ASTYPE expression, similar to the AS construct in other
languages. This will assign a value of the correct type or NULL when
the expression is not of the correct type:

VAR someVariable := <AnExpression> ASTYPE <SomeType>

· The Chr() and _Chr() functions are now converted to a string or

character literal when the parameter is a compile time constant
· Compilation speed for assemblies with larger numbers of functions,
procedures, defines, globals or _dll functions has been improved.
· _DLL FUNCTIONS now automatically are marked with CharSet.Auto

© 2015- 2019 XSharp BV

 X# Documentation 56

· Fixed some inconsistencies between Colon (:) and Point (.)

interoperability and the super keyword
· Fixed several compiler issues reported by FOX subscribers and other
users.

Visual Studio

New features / changed behavior:

· Tested and works with the release version of Visual Studio 2017
· We have added support for regions inside the VS editor. At this
moment most "entities" are collapsible as well as statement blocks,
regions and lists of usings, #includes and comments.
· We have added support for member and type drop downs in the VS
Editor
· We have added support for Code completion in the VS editor
· We have added support for Goto definition in the VS Editor
· Errors detected by the intellisense scanner are now also included in
the VS error list.
· We have added help links to the errors in the VS error list. The help
links will bring you to the appropriate page on the X# website. Not all
the help pages are complete yet, but at least the infrastructure is
working.
· We have added support for snippets and included several code
snippets in the installer
· We have made several changes to the project properties dialogs
o The pre and post build events are now on a
separate page for the Project Properties. These
are now also not defined per configuration but are
shared between the various configurations.
If you want to copy output results to different folders
for different configurations you should use the
$(Configuration) and $(Platform) variables
o We have moved the Platform and Prefer32Bits
properties to the Build page to make them
configuration dependent
o Fixed a problem with casing of the AnyCPU
platform which would result in duplicate items in
the VS Platform combobox
o Added support for ARM and Itanium platform types
o Some properties were saved in project file groups
without a platform identifier. This has been fixed
o We have added a project property to control how
Managed file resources are included: Use Vulcan
Compatible Managed Resources
When 'True' then resources files are included in
the assembly without namespace prefix. When
'False' then the resource files are prefixed with the
namespace of the app, just like in other .Net
languages, such as C#
· We have fixed some code generation problems

© 2015- 2019 XSharp BV

57 XSharp Bandol

· The parser that is used in the Windows Forms editor now also
properly handles background images. Both images in the resx for the
form and also background images in the shared project resources
· We have added Nuget support for our project system.
· We have made several changes to fix problems in project files
o The project system now silently fixes problems
with duplicate items
o Fixed a problem with dependencies between
xaml files and their dependent designer.prg files
and other dependent files
o Fixed a problem with dependent items in sub
folders or in a folder tree that includes a dot in a
folder name.
o Fixed a problem in the WPF template
· Fixed a refresh problem when deleting a references node
· Added implementation of the OAProject.Imports property, which is
used by JetBrains

XPorter
· Fixed a problem converting WPF style projects

Changes in 0.2.9

Compiler
With this build you can compile the Vulcan SDK without changes, except for some
obvious errors in the Vulcan SDK that Vulcan did not find!
We consider the Vulcan Compatibility of the compiler finished with the current
state of the compiler. All Vulcan code should compile without proble now.

VO/Vulcan Compatibility

New features / changed behavior:

· All Init procedures are now properly called at startup. So not only the
init procedures in the VOSDK libraries but also init procedures in other
libraries and the main exe
· Changed the method and type resolution code:
o A method with a single object parameter is now
preferred over a method with an Object[] parameter
o When both a function (static method) exists and an
instance method we will now call the static method
in code inside methods that does not have a SELF:
or SUPER: prefix.
o In situations where the @ operator is used to pass
variables by reference.
o To make it more compatible with Vulcan for
overloads with different numeric types.
o To prefer a method with specific parameters over a
method with usual parameters

© 2015- 2019 XSharp BV

 X# Documentation 58

o To avoid problems with Types and Namespaces

with the same name.
o To prefer a method with an OBJECT parameter
over the one with OBJECT[] parameters when only
1 argument is passed
o When 2 identical functions or types are detected in
referenced assemblies we now choose the one in
the first referenced assembly like Vulcan does, and
generate warning 9043
· The sizeof operator now returns a DWORD to be compatible with VO
and Vulcan.
· Added support for EXIT PROCEDURES (PROCEDURE
MyProcedure EXIT). These procedures will automatically be called
during program shutdown, just before all the global variables are
cleared.
The compiler now generates an $Exit function for each assembly in
which the exit procedures will be called and the reference globals in an
assembly will be cleared. In the main app a $AppExit() function is
created that will call the $Exit functions in all references X#
assemblies. When a Vulcan compiled assembly is referenced, then all
the public reference globals will be cleared from the $AppExit()
function.
· Added support for PCALL and PCALLNATIVE
· Added support for several Vulcan compatible compiler options:
o /vo1 Allow Init() and Axit() for constructor and
destruction
o /vo6 Allow (global) function pointers. DotNet does
not "know" these. They are compiled to IntPtr. The
function information is preserved so you can use
these pointer in a PCALL()
o /ppo. Save the preprocessed compiler output to a
file
o /Showdefs Show a list of the defines and their
values on the console
o /showincludes Show a list of the included header
files on the console
o /verbose Shows includes, source file names,
defines and more. on the console
o DEFAULT TO command
o ACCEPT command
o WAIT command
· Several code generation changes:
o Changed the code generation for DIM elements
inside VOStruct arrays because the Vulcan
compiler depends on a specific naming scheme
and did not recognize our names.
o Improved the code generation inside methods with
CLIPPER calling convention.

© 2015- 2019 XSharp BV

59 XSharp Bandol

Bug fixes
· Implicit namespaces are now only used when the /ins compiler option
is enabled. In Vulcan dialect the namespace Vulcan is always
included.
· Fixed several problems with the @ operator and VOSTRUCT types
· Fixed a problem with DIM arrays of VOSTRUCT types
· Fixed a problem with LOGIC values inside VOSTRUCT and UNION
types
· Fixed several problems with the VOStyle _CAST and Conversion
operators.
· Fixed several numeric conversion problems
· Fixed several problems when mixing NULL, NULL_PTR and
NULL_PSZ
· Fixed several problems with the _CAST operator
· Fixed several problems with PSZ Comparisons. X# now works just like
Vulcan and VO and produces the same (sometimes useless) results
· Fixed a problem with USUAL array indexes for multi dimensional
XBase Arrays
· Fixed codeblock problems for codeblocks where the last expression
was VOID
· Changed code generation for NULL_SYMBOL
· Preprocessor #defines were sometimes conflicting with class or
namespace names. For example when /vo8 was selected the method
System.Diagnostics.Debug.WriteLine() could not be called because
the DEBUG define was removing the classname. We have changed
the preprocessor so it will no longer replace words immediately before
or after a DOT or COLON operator.
· Fixed a compiler crash when calling static methods in the
System.Object class when Late Binding was enabled
· Fixed String2Psz() problem inside PROPERTY GET and PROPERTY
SET
· And many more changes.

All dialects

New features / changed behavior:

· Several code generation changes:
o The code generation for ACCESS and ASSIGN has
changed. There are no longer separate methods in
the class, but the content of these methods is now
inlined in the generated Get and Set methods for
the generated property.
o Optimized the code generation for IIF statements.
o The debugger/step information has been
improved. The debugger should now also stop on
IF statements, FOR statements, CASE statements
etc.

© 2015- 2019 XSharp BV

 X# Documentation 60

· Indexed access to properties defined with the SELF keyword can now
also use the "Index" property name
· Functions and Procedures inside classes are not allowed (for now)
· RETURN <LiteralValue> inside an ASSIGN method will no longer
allocate a variable and produce an warning
· Several keywords are now also allowed as Identifier (and will no longer
have to be prefixed with @@ ):
Delegate, Enum, Event, Field, Func, Instance, Interface,
Operator, Proc, Property, Structure, Union, VOStruct and many
more
As a result the following is now valid code (but not recommended):
FUNCTION Start AS VOID
LOCAL INTERFACE AS STRING
LOCAL OPERATOR AS LONG
? INTERFACE, OPERATOR
RETURN
You can see that the Visual Studio language support also recognizes that INTERFACE
and OPERATOR are not used as keywords in this context

Bug fixes
· Fixed a problem with the REPEAT UNTIL statement
· Fixed a crash for code with a DO CASE without a matching END
CASE
· Fixed several issues for the code generation for _DLL FUNCTIONs
and _DLL PROCEDUREs
· Fixed a problem (in the Roslyn code) with embedding Native
Resources in the Assembly.
· Fixed a problem with the _OR() and _AND() operators with more than
2 arguments.
· Added support for Pointer dereferencing using the VO/Vulcan Syntax :
DWORD(p) => p[1]
· Fixed several problems with the @ operator
· When two partial classes had the same name and a different casing
the compiler would not properly merge the class definitions.
· Fixed a crash when a #define in code was the same as a define
passed on the commandline
· Indexed pointer access was not respecting the /AZ compiler option
(and always assumed 0 based arrays). This has been fixed
· Fixed a problem with the caching of preprocessed files, especially files
that contain #ifdef constructs.
· Fixed a problem which could occur when 2 partial classes had the
same name but a different case
· Fixed a compiler crash when a referenced assembly had duplicate
namespaces that were only different in Case
· Fixed problems with Functions that have a [DllImport] attribute.
· Error messages for ACCESS/ASSIGN methods would sometimes
point to a strange location in the source file. This has been fixed.
· Fixed a problem with Init Procedures that had a STATIC modifier

© 2015- 2019 XSharp BV

61 XSharp Bandol

· Fixed a problem in the preprocessor when detecting the codepage for

a header file. This could cause problems reading header files with
special characters (such as the copyright sign ©)
· And many more changes.

Visual Studio Integration

· Added support for all compiler options in the UI and the build system
· Fixed problems with dependent file items in subfolders
· The Optimize compiler option was not working
· The 'Clean' build option now also cleans the error list
· Under certain conditions the error list would remain empty even though
there were messages in the output pane. This has been fixed.
· The <Documentationfile> property inside the xsproj file would cause a
rebuild from the project even when the source was not changed
· Earlier versions of XPorter could create xsproj files that would not build
properly. The project system now fixes this automatically
· Fixed a problem with the build system and certain kind of embedded
managed resources

Documentation
· We have added many descriptions to the commandline options
· We have added a list of the most common compiler errors and warnings.

Changes in 0.2.8

Compiler

VO/Vulcan Compatibility
· Default Parameters are now handled like VO and Vulcan do. This
means that you can also have date constants, symbolic constants etc
as default parameter
· String Single Equals rules are now 100% identical with Visual Objects.
We found one case where Vulcan does not return the same result as
Visual Objects. We have chosen to be compatible with VO.
· When compiling in VO/Vulcan mode then the init procedures in the VO
SDK libraries are automatically called. You do not have to call these in
your code anymore
Also Init procedures in the main assembly are called at startup.
· The /vo7 compiler option (Implicit casts and conversions) has been
implemented. This also includes support to use the @ sign for REF
parameters
· You can now use the DOT operator to access members in
VOSTRUCT variables
· We have fixed several USUAL - Other type conversion problems that
required casts in previous builds

© 2015- 2019 XSharp BV

 X# Documentation 62

· The compiler now correctly parses VO code that contains DECLARE

METHOD, DECLARE ACCESS and DECLARE ASSIGN statements
and ignores these
· The compiler now parses "VO Style" compiler pragma's (~"keyword"
as white-space and ignores these.
· Fixed a problem where arrays declared with the "LOCAL
aSomething[10] AS ARRAY" syntax would not be initialized with the
proper number of elements
· Fixed a problem when calling Clipper Calling Convention constructors
with a single USUAL parameter
· Attributes on _DLL entities would not be properly compiled. These are
recognized for now but ignored.
· Fixed several numeric conversion problems

New features
· We have added support for Collection Initializers and Object Initializers
· Anonymous type members no longer have to be named. If you select a
property as an anonymous type member then the same property
name will be used for the anonymous type as well.
· Missing closing keywords (such as NEXT, ENDIF, ENDCASE and
ENDDO) now produce better error messages
· IIF() Expressions are now also allowed as Expression statement. The
generated code will be the same as if an IF statement was used

FUNCTION IsEven(nValue as LONG) AS LOGIC

LOCAL lEven as LOGIC
IIF( nValue %2 == 0, lEven := TRUE, lEven := FALSE)
RETURN lEven

We really do not encourage to hide assignments like this, but in case you have used this
coding style,it works now <g>.
· AS VOID is now allowed as (the only) type specification for
PROCEDUREs
· We have added a .config file to the exe for the shared compiler that
should make it faster
· The XSharpStdDefs.xh file in the XSharp is now automatically included
when compiling. This file declares the CRLF constant for now.
· Include files are now cached by the compiler. This should increase the
compilation speed for projects that depend on large included files,
such as the Win32APILibrary header file from Vulcan
· When a function is found in an external assembly and a function with
the same name and arguments is found in the current assembly, then
the function in the current assembly is used by the compiler
· Compiler error messages for missing closing symbols should have
been improved
· Compiler error messages for unexpected tokens have been improved

Bug fixes
· Several command-line options with a minus sign were not properly
handled by the compiler

© 2015- 2019 XSharp BV

63 XSharp Bandol

· Fixed several crashes related to assigning NULL_OBJECT or NULL to

late bound properties have been fixed
· Partial class no longer are required to specify the parent type on every
source code location. When specified, the parent type must be the
same of course. Parent interfaces implemented by a class can also
be spread over multiple locations
· We have fixed a crash that could happen with errors/warnings in large
include files
· Abstract methods no longer get a Virtual Modifier with /vo3
· Fixed a problem with virtual methods in child classes that would hide
parent class methods
· Automatic return value generation was also generating return values
for ASSIGN methods. This has been fixed.
· We fixed a problem with the Join Clauses for LINQ Expressions that
would cause a compiler exception
· The /vo10 (compatible iif) compiler option no longer adds casts in the
Core dialect. It only does that for the VO/Vulcan dialect

Visual Studio Integration

We have changed the way the error list and output window are updated. In previous
version some lines could be missing on the output window, and the error code column
was empty. This should work as expected now.
· We have merged some code from some other MPF based project
systems, such as WIX (called Votive), NodeJS and Python (PTVS) to
help extend our project system. As a result:
o Our project system now has support for Linked
files
o Our project system now has support for 'Show All
Files' and you can now Include and Exclude files.
This setting is persisted in a .user file, so you can
exclude this from SCC if you want.
o We have made some changes to support better
'Drag and Drop'
· We have fixed several issues with regard to dependent items
· When you include a file that contains a form or user control, this is
now recognized and the appropriate subtype is set in the project file,
so you can open the windows forms editor
· We are now supporting source code generation for code behind files
for .Settings and .Resx files
· The combobox in the Managed Resource editor and Managed Settings
tool to choose between internal code and public code is now enabled.
Selecting a different value in the combobox will change the tool in the
files properties.
· The last response file for the compiler and native resource compiler
are now saved in the users Temp folder to aid in debugging problems.
· The response file now has each compiler option to a new line to make
it easier to read and debug when this is necessary.
· The code generation now preserves comments between entities
(methods)
· We fixed several minor issues in the templates

© 2015- 2019 XSharp BV

 X# Documentation 64

· When the # of errors and warnings is larger than the built-in limit of
500, then a message will be shown that the error list was truncated
· At the end of the build process a line will be written to the output
window with the total # of warnings and errors found
· The colors in the Source Code Editor are now shared with the source
code editors for standard languages such as C# and VB
· When you have an inactive code section in your source code,
embedded in an #ifdef that evaluates to FALSE then that section will
be visibly colored gray and there will be no keyword highlighting. The
source code parser for the editor picks up the include files and
respects the path settings. Defines in the application properties dialog
and the active configuration are not respected yet. That will follow in
the next build.

Changes in 0.2.7.1

Compiler
· The compiler was not accepting wildcard strings for the
AssemblyFileVersion Attribute and the AssemblyInformationVersion
attribute. This has been fixed
· The #Pragma commands #Pragma Warnings(Push) and #Pragma
Warnings(Pop) were not recognized. This has been fixed.
· The compiler was not recognizing expressions like
global::System.String.Compare(..). This has been fixed

Visual Studio Integration

· Dependent items in subfolders of a project were not recognized
properly and could produce an error when opening a project
· Fixed a problem in the VulcanApp Template
· The Windows Forms Editor would not open forms in a file without
begin namespace .. end namespace. This has been fixed
· Source code comments between 'entities' in a source file is now
properly saved and restored when the source is regenerated by the
form editor
· Unnecessary blank lines in the generate source code are being
suppressed
· The XPorter tool is now part of the Installation
· Comments after a line continuation character were not properly
colored
· Changed the XSharp VS Editor Color scheme to make certain items
easier to read
· New managed resource files would not be marked with the proper item
type. As a result the resources would not be available at runtime. This
has been fixed.
· Added 'Copy to Output Directory' property to the properties window

Setup
· The installer, exe files and documentation are now signed with a
certificate

© 2015- 2019 XSharp BV

65 XSharp Bandol

Changes in 0.2.7

Compiler

New features:
· Added support for the VOSTRUCT and UNION types
· Added support for Types as Numeric values, such as in the construct
IF UsualType(uValue) == LONG
· Added a FIXED statement and FIXED modifier for variables
· Added support for Interpolated Strings
· Empty switch labels inside SWITCH statements are now allowed.
They can share the implementation with the next label.
Error 9024 (EXIT inside SWITCH statement not allowed) has been
added and will be thrown if you try to exit out of a loop around the
switch statement.
This is not allowed.
· Added support for several /vo compiler options:
- vo8 (Compatible preprocessor behavior). This makes the
preprocessor defines case insensitive. Also a define with the value
FALSE or 0 is seen as 'undefined'
- vo9 (Allow missing return statements) compiler option. Missing return
values are also allowed when /vo9 is used.
Warnings 9025 (Missing RETURN statement) and 9026 (Missing
RETURN value) have been added.
- vo12 (Clipper Integer divisions)
· The preprocessor now automatically defines the macros __VO1__
until __VO15__ with a value of TRUE or FALSE depending on the
setting of the compiler option
· The FOX version of the compiler is now distributed in Release mode
and much faster. A debug version of the compiler is also installed in
case it is needed to aid in finding compiler problems.

Changed behavior
· The compiler generated Globals class for the Core dialect is now
called Functions and no longer Xs$Globals.
· Overriding functions in VulcanRTFuncs can now be done without
specifying the namespace:
When the compiler finds two candidate functions and one of them is
inside VulcanRTFuncs then the function that is not in VulcanRTFuncs
is chosen.
· Warning 9001 (unsafe modifier implied) is now suppressed for the
VO/Vulcan dialect. You MUST pass the /unsafe compiler option if you
are compiling unsafe code though!
· Improved the error messages for the Release mode of the compiler

© 2015- 2019 XSharp BV

 X# Documentation 66

Bug fixes
· RETURN and THROW statements inside a Switch statement would
generate an 'unreachable code' warning. This has been fixed
· Fixed several problems with mixing signed and unsigned Array Indexes
· Fixed several problems with the FOR .. NEXT statement. The "To"
expression will now be evaluated for every iteration of the loop, just like
in VO and Vulcan.
· Fixed several compiler crashes
· Fixed a problem with implicit code generation for constructors
· Fixed a visibility problem with static variables inside static functions

Visual Studio Integration

· Fixed a problem that the wrong Language Service was selected when
XSharp and Vulcan.NET were used in the same Visual Studio and
when files were opened from the output window or the Find Results
window
· Fixed some problems with 'abnormal' line endings in generated code
· Fixed a problem in the Class Library template
· Fixed a problem with non standard command lines to Start the
debugger
Changes in 0.2.6

Compiler
· Added alternative syntax for event definition. See EVENT keyword in
the documentation
· Added Code Block Support
· Implemented /vo13 (VO compatible string comparisons)
· Added support for /vo4 (VO compatible implicit numeric conversions)
· Aliased expressions are now fully supported
· Fixed a problem with the &= operator
· Fixed several crashes for incorrect source code.
· Fixed several problems related to implicit conversions from/to usual,
float and date
· Indexed properties (such as String:Chars) can now be used by name
· Indexed properties can now have overloads with different parameter
types
· Added support for indexed ACCESS and ASSIGN
· Fixed a problem when calling Clipper Calling Convention functions
and/or methods with a single parameter
· Fixed a crash with defines in the preprocessor
· _CODEBLOCK is now an alias for the CODEBLOCK type
· Fixed a crash for properties defined with parentheses or square
brackets, but without actual parameters

Visual Studio Integration

· Completed support for .designer.prg for Windows.Forms

© 2015- 2019 XSharp BV

67 XSharp Bandol

· Fixed an issue in the CodeDom generator for generating wrappers for

Services
· The XSharp Language service will no longer be used for Vulcan PRG
files in a Side by Side installation
· Editor performance for large source files has been improved.
· All generated files are now stored in UTF, to make sure that special
characters are stored correctly. If you are seeing warnings about code
page conversions when generating code, then save files as UTF by
choosing "File - Advanced Save Options", and select a Unicode file
format, from the Visual Studio Menu.
Changes in 0.2.51

Visual Studio Integration & Build System

· The Native Resource compiler now "finds" header files, such as
"VOWin32APILibrary.vh" in the Vulcan.NET include folder. Also the
output of the resource compiler is now less verbose when running in
"normal" message mode. When running in "detailed" or "diagnostics"
mode the output now also includes the verbose output of the resource
compiler.

Compiler
· Fixed a problem that would make PDB files unusable
· The error "Duplicate define with different value" (9012) has been
changed to warning, because our preprocessor does a textual
comparison and does not "see" that "10" and "(10)" are equal as well
as "0xA" and "0xa". It is your responsibility of course to make sure that
the values are indeed the same.
· Exponential REAL constants were only working with a lower case 'e'.
This is now case insensitive
· Made several changes to the _DLL FUNCTION and _DLL
PROCEDURE rules for the parser. Now we correctly recognize the
"DLL Hints " (#123) and also allow extensions in these definitions.
Ordinals are parsed correctly as well, but produce an error (9018)
because the .Net runtime does not support these anymore. Also the
Calling convention is now mandatory and the generated IL code
includes SetLastError = true and ExactSpelling = true.
· Fixed a problem with the ~ operator. VO and Vulcan (and therefore X#)
use this operator as unary operator and as binary operator.
The unary operator does a bitwise negation (Ones complement), and
the binary operator does an XOR.
This is different than C# where the ~ operator is Bitwise Negation and
the ^ operator is an XOR (and our Roslyn backend uses the C# syntax
of course).
Changes in 0.2.5

Visual Studio Integration

· Fixed a problem where the output file name would contain a pipe
symbol when building for WPF

© 2015- 2019 XSharp BV

 X# Documentation 68

· Fixed a problem with the Item type for WPF forms, pages and user
controls
· The installer now has an option to not take away the association for
PRG, VH and PPO items from an installed Vulcan project system.
· Added support for several new item types in the projects
· Added support for nested items
· Added several item templates for WPF, RC, ResX, Settings, Bitmap,
Cursor etc.

Build System
· Added support for the new /vo15 command line switch.
· Added support for compiling native resources.

Compiler
· A reference to VulcanRT and VulcanRTFuncs is now mandatory when
compiling in VO/Vulcan dialect
· Added support for indexed access for VO/Vulcan Arrays
· Added support for VO/Vulcan style Constructor chaining (where
SUPER() or SELF() call is not the first call inside the constructor body)
· Added support for the &() macro operator in the VO/Vulcan dialect
· Added support for the FIELD statement in the VO/Vulcan dialect
o The statement is recognized by the compiler
o Fields listed in the FIELD statement now take
precedence over local variables or instance
variables with the same name
· Added support for the ALIAS operator (->) in the VO/Vulcan dialect,
with the exception of the aliased expressions (AREA->(<Expression>))
· Added support for Late bound code (in the VO/Vulcan dialect)
o Late bound method calls
o Late bound property get
o Late bound property set
o Late bound delegate invocation
· Added a new /vo15 command line option (Allow untyped Locals and
return types):
By default in the VO/Vulcan dialect missing types are allowed and
replaced with the USUAL type.
When you specify /vo15- then untyped locals and return types are not
allowed and you must specify them.
Of course you can also specify them as USUAL
· The ? and ?? statement are now directly mapped to the appropriate
VO/Vulcan runtime function when compiling for the VO/Vulcan dialect
· We now also support the VulcanClassLibrary attribute and
VulcanCompilerVersion attribute for the VO & Vulcan dialect.
With this support the Vulcan macro compiler and Vulcan Runtime
should be able to find our functions and classes
· The generated static class name is now more in par with the class
name that Vulcan generates in the VO & Vulcan dialect.
· Added several implicit conversion operations for the USUAL type.

© 2015- 2019 XSharp BV

69 XSharp Bandol

· When accessing certain features in the VO & Vulcan dialect (such as

the USUAL type) the compiler now checks to see if
VulcanRTFuncs.DLL and/or VulcanRT.DLL are included.
When not then a meaningful error message is shown.
· Added support for the intrinsic function _GetInst()
· Fixed a problem with case sensitive namespace comparisons
· Fixed a problem with operator methods
· Added preprocessor macros __DIALECT__, __DIALECT_CORE__,
__DIALECT_VO__ and __DIALECT_VULCAN__
· The _Chr() pseudo function will now be mapped to the Chr() function
· Added support for missing arguments in arguments lists (VO & Vulcan
dialect only)
· Fixed a crash when calculating the position of tokens in header files
· The installer now offers to copy the Vulcan Header files to the XSharp
Include folder
· Added support for skipping arguments in (VO) literal array constructors

Documentation
· Added the XSharp documentation to the Visual Studio Help collection
· Added reference documentation for the Vulcan Runtime
Changes in 0.2.4

Visual Studio Integration

· Double clicking errors in the error browser now correctly opens the
source file and positions the cursor
· Fixed several problems in the project and item templates
· The installer now also detects Visual Studio 15 Preview and installs
our project system in this environment.

Build System
· Fixed a problem with the /unsafe compiler option
· Fixed a problem with the /doc compiler option
· Treat warnings as error was always enabled. This has been fixed.

Compiler
· Added support for Lambda expressions with an expression list
LOCAL dfunc AS System.Func<Double,Double>
dfunc := {|x| x := x + 10, x^2}
? dfunc(2)
· Added support for Lambda expressions with a statement list
LOCAL dfunc AS System.Func<Double,Double>
dfunc := {|x|
? 'square of', x
RETURN x^2
}
· Added support for the NAMEOF intrinsic function
FUNCTION Test(cFirstName AS STRING) AS VOID
FUNCTION Test(cFirstName AS STRING) AS VOID

© 2015- 2019 XSharp BV

 X# Documentation 70

IF String.IsNullOrEmpty(cFirstName)
THROW ArgumentException{"Empty argument", nameof(cFirstName)}
ENDIF
· Added support for creating methods and functions with Clipper calling convention (VO
and Vulcan dialect only)
· Using Statement now can contain a Variable declaration:
Instead of:
VAR ms := System.IO.MemoryStream{}
BEGIN USING ms
// do the work

END USING
You can now write
BEGIN USING VAR ms := System.IO.MemoryStream{}
// do the work
END USING
· Added support for /vo10 (Compatible IIF behavior). In the VO and
Vulcan dialect the expressions are cast to USUAL. In the core dialect
the expressions are cast to OBJECT.

New language features for the VO and Vulcan dialect

· Calling the SELF() or SUPER() constructor is now allowed anywhere
inside a constructor (VO and Vulcan dialect only). The Core dialect still
requires constructor chaining as the first expression inside the
constructor body
· Added support for the PCOUNT, _GETFPARAM and _GETMPARAM
intrinsic functions
· Added support for String2Psz() and Cast2Psz()
· Added support for BEGIN SEQUENCE … END
· Added support for BREAK

Fixed several problems:

· Nested array initializers
· Crash for BREAK statements
· Assertion error for generic arguments
· Assertion on const implicit reference
· Allow ClipperCallingConvention Attribute on Constructors, even when it
is marked as ‘for methods only’
· Fixed a problem with Global Const declarations
· __ENTITY__ preprocessor macro inside indexed properties

Changes in 0.2.3

Visual Studio Integration

· We have changed to use the MPF style of Visual Studio Integration.
· We have added support for the Windows Forms Editor
· We have added support for the WPF Editor

© 2015- 2019 XSharp BV

71 XSharp Bandol

· We have added support for the Codedom Provider, which means a

parser and code generator that are used by the two editors above
· The project property pages have been elaborated. Many more features
are available now.
· We have added several templates

Build System
· Added support for several new commandline options, such as /dialect
· The commandline options were not reset properly when running the
shared compiler. This has been fixed.
· The build system will limit the # of errors passed to Visual Studio to
max. 500 per project. The commandline compiler will still show all
errors.

Compiler
· We have started work on the Bring Your Own Runtime support for
Vulcan. See separate heading below.
· The __SIG__ and __ENTITY__ macros are now also supported, as
well as the __WINDIR__, __SYSDIR__ and __WINDRIVE__ macros
· The debugger instructions have been improved. You should have a
much better debugging experience with this build
· Several errors that indicated that there are visibility differences
between types and method arguments, return types or property types
have been changed into warnings. Of course you should consider to
fix these problems in your code.
· The #Error and #warning preprocessor command no longer require
the argument to be a string
· The SLen() function call is now inlined by the compiler (just like in
Vulcan)
· The AltD() function will insert a call to
"System.Diagnostics.Debugger.Break" within a IF
System.Diagnostics.Debugger.IsAttached check
· Several compiler crashes have been fixed
· Added support for the PARAMS keyword for method and function
parameters.
· Fixed a problem for the DYNAMIC type.

BYOR
· XBase type names are resolved properly (ARRAY, DATE, SYMBOL,
USUAL etc)
· Literal values are now resolved properly (ARRAY, DATE, SYMBOL)
· NULL_ literals are resolved properly (NULL_STRING follows the /vo2
compiler option, NULL_DATE, NULL_SYMBOL)
· The /vo14 compiler option (Float literals) has been implemented
· The compiler automatically inserts a "Using Vulcan" and "using static
VulcanRtFuncs.Functions" in each program
· You MUST add a reference to the VulcanRTFuncs and VulcanRT
assembly to your project. This may be a Vulcan 3 and also a Vulcan 4

© 2015- 2019 XSharp BV

 X# Documentation 72

version of the Runtime. Maybe Vulcan 2 works as well, we have not

tested it.
· Calling methods with Clipper calling convention works as expected.
· Methods/Functions without return type are seen as methods that
return a USUAL
· If a method/function contains typed and typed parameters then the
untyped parameters are seen as USUAL parameters
· Methods with only untyped parameters (Clipper calling convention) are
not supported yet
· The ? command will call AsString() on the arguments

Changes in 0.2.2

Visual Studio Integration

· Added more project properties. One new property is the "Use Shared
Compiler" option. This will improve compilation speed, but may have a
side effect that some compiler (parser) errors are not shown in
details.
If you experience this, then please disable this option.
· Added more properties to the Build System. All C# properties should
now also be supported for X#, even though some of them are not
visible in the property dialogs inside VS.
· Added a CreateManifest task to the Build System so you will not get an
error anymore for projects that contain managed resources
· The performance of the editor should be better with this release.
· Marking and unmarking text blocks as comment would not always be
reflected in the editor colors. This has been fixed.

Compiler
· We have added a first version of the preprocessor. This
preprocessor supports the #define command, #ifdef, #ifndef, #else,
#endif, #include, #error and #warning. #command and #translate (to
add user defined commands) are not supported yet.
· Missing types (in parameter lists, field definitions etc) were sometimes
producing unclear error messages. We have changed the compiler to
produce a "Missing Type" error message.
· We rolled the underlying Roslyn code forward to VS 2015 Update 1.
Not that you see much of this from the outside <g>, but several fixes
and enhancements have made their way into the compiler.
· Added a YIELD EXIT statement (You can also use YIELD BREAK).
· Added an (optional) OVERRIDE keyword which can be used as
modifier on virtual methods which are overridden in a subclass.
· Added a NOP keyword which you can use in code which is
intentionally empty (for example the otherwise branch of a case
statement. The compiler will no longer warn about an empty block
when you insert a NOP keyword there.

© 2015- 2019 XSharp BV

73 XSharp Bandol

· The On and Off keywords could cause problems, because they were
not positional (these are part of the pragma statement). This has been
fixed.
· _AND() and _OR() expressions with one argument now throw a
compiler error.
· The compiler now recognizes the /VO14 (store literals as float)
compiler switch (it has not been implemented yet).
· Added a ** operator as alias for the ^ (Exponent) operator.
· Added an "unsupported" error when using the Minus operator on
strings.
· Fixed a "Stack overflow" error in the compiler that could occur for very
long expressions.
· The right shift operator no longer conflicts with two Greater Than
operators, which allows you to declare or create generics without
having to put a space between them.
(var x := List<Tuple<int,int>>{}

Changes in 0.2.1

Visual Studio Integration

· Added and improved several project properties
· Fix a problem with the "Additional Compiler Options"
· Improved coloring in the editor for Keywords, Comments etc. You can
set the colors from the Tools/Options dialog under General/Fonts &
Colors. Look for the entries with the name "XSharp Keyword" etc.
· Added Windows Forms Template

Compiler
· Several errors have been demoted to warnings to be more compatible
with VO/Vulcan
· Added support for Comment lines that start with an asterisk
· Added support for the DEFINE statement. For now the DEFINE
statement MUST have a type
DEFINE WM_USER := 0x0400 AS DWORD
· Fixed problem with Single Line Properties with GET and SET reversed
· Several fixes for Virtual and Non virtual methods in combination with
the /VO3 compatibility option

Changes in 0.1.7
· The "ns" (add default namespace to classes without namespace) has
been implemented
· The "vo3" compiler option (to make all methods virtual ) has been
implemented
· Fixed an issue where the send operator on an expression between
parentheses was not compiling properly
· Relational operators for strings (>, >=, <, <=) are now supported. They
are implemented using the String.Compare() method.

© 2015- 2019 XSharp BV

 X# Documentation 74

· Fixed a problem with local variables declared on the start line from
FOR .. NEXT statements
· Added first version of the documentation in CHM & PDF format
· Added several properties to the Visual Studio Project properties dialog
to allow setting the new compiler options
· Fixed a problem in the Targets files used by MsBuild because some
standard macros such as $(TargetPath) were not working properly
· XIDE 0.1.7 is included. This version of XIDE is completely compiled
with XSharp !
· The name of some of the MsBuild support files have changed. This
may lead to problems loading a VS project if you have used the VS
support from the previous build. If that is the case then please edit the
xsproj file inside Visual Studio and replace all references of
"XSharpProject" with "XSharp" . Then safe the xsproj file and try to
reload the project again
· The WHILE.. ENDDO (a DO WHILE without the leading DO) is now
recognized properly

Changes in 0.1.6
· This version now comes with an installer
· This version includes a first version of the Visual Studio Integration.
You can edit, build, run and debug inside Visual Studio. There is no
"intellisense" available.
· The compiler now uses 1-based arrays and the “az” compiler option
has been implemented to switch the compiler to use 0-based arrays.
· The "vo2" compiler option (to initialize string variables with
String.Empty) has been implemented
· Please note that there is no option in the VS project properties dialog
yet for the az and vo2 compiler options. You can use the "additional
compiler options" option to specify these compiler options.
· The text "this" and "base" in error messages has been changed to
"SELF" and "SUPER"
· Error of type “visibility” (for example public properties that expose
private or internal types) have been changed to warnings
· Fixed a problem with TRY … ENDTRY statements without CATCH
clause
· The compiler now has a better resolution for functions that reside in
other (X#) assemblies
· Fixed a problem which could lead to an "ambiguous operator"
message when mixing different numeric types.

Changes in 0.1.5
· When an error occurs in the parsing stage, X# no longer enters the
following stages of the compiler to prevent crashes. In addition to the
errors from the parser also an error 9002 is displayed.
· Parser errors now also include the source file name in the error
message and have the same format as other error messages. Please
note that we are not finished yet with handling these error messages.

© 2015- 2019 XSharp BV

75 XSharp Bandol

There will be improvements in the format of these error messages in

the upcoming builds.
· The compiler will display a “feature not available” (8022) error when a
program uses one of the Xbase types (ARRAY, DATE, FLOAT, PSZ,
SYMBOL, USUAL).
· Fixed an error with VOSTRUCT and UNION types
· Fixed a problem with the exclamation mark (!) NOT operator

Changes in 0.1.4
· Several changes to allow calculations with integers and enums
· Several changes to allow VO compatible _OR, _AND, _NOT an _XOR
operations
· Fix interface/abstract VO properties
· Insert an implicit “USING System” only if not explicitly declared
· Error 542 turned to warning (members cannot have the same name
as their enclosing type)
· Changes in the .XOR. expression definition
· Fix double quote in CHAR_CONST lexer rule
· Allow namespace declaration in class/struct/etc. name (CLASS
Foo.Bar)
· Fix access/assign crash where identifier name was a (positional)
keword: ACCESS Value
· Preprocessor keywords were not recognized after spaces, but only at
the start of the line. This has been fixed.
· Prevent property GET SET from being parsed as expression body
· Fix default visibility for interface event
· Unsafe errors become warnings with /unsafe option, PTR is void*
· Fix dim array field declaration
· Initial support of VO cast and VO Conversion rules (TYPE(_CAST,
Expression) and TYPE(Expression)). _CAST is always unchecked
(LONG(_CAST, dwValue)) and convert follows the
checked/unchecked rules (LONG(dwValue))
· Fixed problem with codeblock with empty parameter list
· Fixed problems with GlobalAttributes.
· An AUTO property without GET SET now automatically adds a GET
and SET block
· Allow implicit constant double-to-single conversion

Changes in 0.1.3
· Change inconsistent field accessibility error to warning and other
similar errors
· Added commandline support for Vulcan arguments. These arguments
no longer result in an error message, but are not really implemented,
unless an equivalent argument exists for the Roslyn (C#) compiler. For
example: /ovf and /fovf are both mapped to /checked, /wx is mapped to
/warnaserror. /w should not be used because that has a different
meaning /warning level). /nowarn:nnnn should be used in stead

© 2015- 2019 XSharp BV

 X# Documentation 76

· Fixed problem where the PUBLIC modifier was assigned to Interface

Members or Destructors
· Prevent expression statements from starting with CONSTRUCTOR()
or DESTRUCTOR()
· Added support for ? statement without parameters
· The default return type for assigns is now VOID when not specified
· Added support for “old Style” delegate instantiation
· Added support for Enum addition
· Added an implicit empty catch block for TRY .. END TRY without catch
and finally
· Added support for the DESCENDING keyword in LINQ statements
· Added support for VIRTUAL and OVERRIDE for Properties and Events
· Prevent implied override insertion for abstract interface members
· Fixed a problem where System.Void could not be resolved
· Fixed problem with Property Generation for ACCESS/ASSIGN
· Fixed problem with Abstract method handling

Changes in 0.1.2.1
· Added default expression
· Fixed problem with events
· Fixed some small lexer problems
· Fixed problem with _DLL FUNCTION and _DLL PROCEDURE

Changes in 0.1.2
· Fixed problem with handling escape sequences in extended strings
· Fixed issue in FOR.. NEXT statements
· Fixed a problem with SWITCH statements
· Fixed a problem with the sizeof() operator
· Fixed a problem in the REPEAT .. UNTIL statement
· Fixed a problem in TRY .. CATCH .. FINALLY .. END TRY statements.
· Fixed issue in Conditional Access Expression ( Expr ? Expr)
· Allow bound member access of name with type args
· Fixed problem in LOCAL statement with multiple locals
· Fixed a problem when compiling with debug info for methods without a
body
· Optimized the Lexer. This should increase the compile speed a lot
· Fixed a problem in the code that reports that a feature is not supported
yet
· Fixed a problem when defining Generic types with a STRUCTURE
constraint
· Compilere macros (__ENTITY__, __LINE__ etc) were causing a
crash. For now the compiler inserts a literal string with the name of the
macro.
· Build 0.1.1 did not contain XSC.RSP
· Fixed a problem where identifiers were not recognized when they were
matching a (new) keyword

© 2015- 2019 XSharp BV

 77 XSharp Bandol

1.1.2 Dialects
The X# compiler can run in different dialects. The table below shows the differences
between these dialects.
You can use the /dialect compiler option to select the dialect that you want to use. The
Core dialect is default.

Feature Core VO & Harbour Xbase++ FoxPro

Vulcan 1,2 14
1,2
4 Letter abbreviations of No VO: Yes, Yes Follow Yes
keywords Vulcan: the
(FUNC, WHIL etc). No conventio
(Vulcan) ns of
11
Xbase++
&& as single line comment No VO: Yes Yes Yes Yes
character (alternative syntax Vulcan:
for //) No

* at beginning of line as Yes Yes Yes Yes Yes

comment character
ALIAS (->) operator No Yes Yes Yes Yes
ARRAY type, Including Array No Yes Yes Yes Yes
literals & NULL_ARRAY,
including missing elements
BREAK statement No Yes Yes Yes Yes
BEGIN SEQUENCE .. No Yes Yes Yes Yes
RECOVER .. END
SEQUENCE
CLIPPER calling convention No Yes Yes Yes Yes
(requires USUAL support)
CODEBLOCK type No Yes Yes Yes Yes
DATE type, including No Yes Yes Yes Yes
NULL_DATE
DATE and DateTime Yes Yes Yes Yes Yes
literals
DEFINE statement with Yes Yes Yes Yes Yes
optional type clause
FIELD statement, and No Yes Yes Yes Yes
recognition of Field names in
stead of locals or instance
variables

© 2015- 2019 XSharp BV

 X# Documentation 78

Feature Core VO & Harbour Xbase++ FoxPro

Vulcan 1,2 14
1,2
FLOAT type, including Float No Yes Yes Yes Yes
literals & the /vo14 compiler
option
GLOBAL statement Yes Yes Yes Yes Yes
IIF() expression and Yes 7 Yes 7 Yes Yes Yes
the /vo10 compiler option
Late binding No Yes Yes Yes Yes
(with /lb+)
MACRO compiler No 13 Yes Yes Yes Yes
MEMVAR, PUBLIC, No VO: Yes, Yes Yes Yes
PRIVATE, PARAMETERS Vulcan:
statement , including No
undeclared variables 14
PSZ Type, including No Yes Yes Yes Yes
NULL_PSZ and (pseudo)
PSZ conversion functions
(String2Psz(), Cast2Psz()
PSZ Indexer n/a VO: 1 Yes Yes Yes
based,
Vulcan 0
based
NULL_STRING Yes 9 Yes 9 Yes Yes Yes
SYMBOL type, including No Yes Yes Yes Yes
Symbol literals &
NULL_SYMBOL
USUAL type, including NIL No Yes Yes Yes Yes
literal
Special features Yes Yes Yes
Untyped Literal Arrays No Yes 8 Yes Yes Yes
Missing types allowed No Yes 3 Yes Yes Yes
Missing arguments in No Yes Yes Yes Yes
function/method calls
MyFunc(1,,2)
Pseudo functions Yes Yes Yes
PCount(), _GetMParam(), No Yes 4 Yes 4 Yes 4 Yes 4
_GetFParam(), _Args()
SLen() No Yes 5 Yes 5 Yes 5 Yes 5

© 2015- 2019 XSharp BV

79 XSharp Bandol

Feature Core VO & Harbour Xbase++ FoxPro

Vulcan 1,2 14
1,2
_Chr() No Yes Yes Yes Yes
AltD() No Yes 6 Yes 6 Yes 6 Yes 6
PCall, PCallNative No Yes Yes Yes Yes
CCall, CCallNative No Yes Yes Yes Yes
Other information
Generated Function class Functions <AssemblyName>.Functions
name X$<Modul (DLLs)
eName>$ <AssemblyName>.Exe.Function
Functions s (EXEs)
<AssemblyName>.Exe.$<Modul
for static eName>$.Functions
functions for static functions and globals
and
globals
VOSTRUCT and AS/IS No 10 Yes Yes Yes Yes
syntax
UNION and AS/IS syntax No 10 Yes Yes Yes Yes

1. Requires VulcanRT.DLL or XSharp.VO.DLL

2. Requires VulcanRTFuncs.DLL or XSharp.VO.DLL
3. Missing types get translated to USUAL. With the new /vo15 compiler
option you can tell the compiler that you do not want to allow missing
types
4. Only supported inside functions and methods with Clipper Calling
convention
5. The Vulcan runtime does not have a SLen() function. The compiler
translates this to accessing the Length property of the string
6. This gets translated to
IF System.Diagnostics.Debugger.Attached
System.Diagnostics.Debugger.Break()
ENDIF
7. In the core dialect each of the expressions is cast to OBJECT. In the
other dialects the expression is cast to USUAL.
8. Untyped literal arrays in the VO/Vulcan dialect are translated to the VO
Array type:
{"aa", "bb", "cc"}
Typed literal arrays are prefixed with <Type> like this:
<STRING>{"aa", "bb", "cc"}
This becomes a literal string array
9. With the /vo2 compiler option NULL_STRING is compiled to an empty
string. Otherwise to a NULL.
10. The VOSTRUCT and UNION can be replaced with a standard .NET
structure. For Union you need to use the
[StructLayout(LayoutKind.Explicit)] attribute on the structure and the

© 2015- 2019 XSharp BV

 X# Documentation 80

[FieldOffSet()] attribute on each field to explicitly define the location of

the fields.
11. Only for VO compatible keywords, not for keywords introduced in
Vulcan or XSharp.
12. The true and false expressions for an IIF() are optional in Harbour and
XBase++
13. The macro compiler is not supported. However when you use the
RDD system in the Core dialect then the index expression will still use
the macro compiler and a reference to the XSharp.RT.DLL is needed
for the support of the macro compiler.
14. This requires the XSharp runtime.

1.1.3 Bring Your Own Runtime (BYOR)

The X# Runtime is now available. There is no need anymore to compile against

the Vulcan Runtime !

VO and Vulcan support is available in this build of XSharp through what we call the Bring
Your Own Runtime principle.

If you own a license of Vulcan, you can copy the DLLs that you find in the <Vulcan.NET
BaseFolder>\Redist\4.0 folder to a folder that is inside your solution.
Then add references to the DLLs that you need in your project.

DLLs you MUST add if you compile for the VO/Vulcan dialect:

· VulcanRT.DLL
· VulcanRTFuncs.DLL

These 2 files are NEVER added to your Vulcan projects, Vulcan adds a reference to these
DLLs automatically. XSharp does not do that, so you should add them yourself.

DLLs that you MAY want to add, depending on what you are using in your
application:

· VulcanVOSystemClasses.dll
· VulcanVORDDClasses.dll
· VulcanVOGUIClasses.dll
· VulcanVOInternetClasses.dll
· VulcanVOSQLClasses.dll
· VulcanVOConsoleClasses.dll
· VulcanVOWin32APILibrary.dll

DLLs that you normally do NOT add to your project (these are handled
automatically by the Vulcan Runtime)
· VulcanRDD.DLL
· VulcanMacroCompiler.DLL
· VulcanDBFCDX.dll

© 2015- 2019 XSharp BV

 81 XSharp Bandol

· VulcanDBFFPT.dll

1.1.4 Known Issues

The current build of the X# compiler can compile the Vulcan SDK without changes, except
for some obvious errors in the Vulcan SDK that Vulcan did not find!
We consider the Vulcan Compatibility of the compiler finished. All Vulcan code should
compile without problems now.
The next builds of the compiler will focus on bug fixing and adding some VO compatibility
options which are listed below as well as adding some new features.
Below is the complete (but short) list of things that are not supported yet or are known
problems in the current build of X#.

Compiler
· Some VO compatibility compiler options are not implemented yet. The
command line options are recognized but nothing is done with them
/cs: Case Sensitivity (the compiler is now always Case Insensitive)
/vo 11: VO Compatible Numeric conversions
· The compiler pragmas (#pragma warnings and #pragma options) do
not work. They are ignored by the compiler.
· Some parser errors need improvements
· Compiler errors may be cryptic every now and then
· The compiler is case insensitive. There may be a problem with case
insensitive matching of interface member names. The case
insensitivity cannot be switched off for now.
We have also seen problems for classes where different member
names are defined with a name that is only different in case.
· Sometimes you may see a "Include file not found" error, where the file
DOES exist. This seems to be a side effect of the codepage that was
used to save the include files.
When you save the file as UTF8 (File Advanced Save Options in Visual
Studio) then this problem almost always disappears.

Visual Studio
· New features in the Debugger, such as a window for Globals and RDD
Workareas

VO Xporter
· DbServer and Fieldspec binaries are not exported yet

Runtime
· Some runtime functions are not supported yet.

1.1.5 Installation
When you install XSharp you will find the following folders on your machine.

Folder Contents

© 2015- 2019 XSharp BV

 X# Documentation 82

C:\Program Files Main installation folder

(x86)\XSharp
- Assemblies the runtime assemblies that are selectable in the Add Reference
dialog inside Visual Studio.
Please note that this is a subset of the folders in the Redist
Folder. For deploying your apps please use the files in the Redist
folder
- Bin The command line compiler, the Script interpreter and Vulcan
XPorter
- Debug Debug versions of the runtime DLLs and SDK DLLs (FOX only)
- Extension The components that must be installed inside Visual Studio for
the X# project system and Language support.
If you want to reinstall the project systems you should run the
deployvs2015.cmd and / or deployvs2017.cmd files in the Uninst
folder. These files were created at install time and match your
specific configuration of Visual Studio versions.
- Help The PDF, CHM help files and the Visual Studio help
- Images Some images
- Include XSharpDefs.xh and other header files needed by X#
- MsBuild The MsBuild integration for XsProj files
- NetCore20 A version of the X# compiler and script engine for .Net Core 2.0
(FOX only)
- ProjectSystem VSIX files to install the project system and debugger inside Visual
Studio.
Only use these when the X# support team tells you to do so.
- Redist Files that you may want to include with your application compiled
with X#.
- Tools Tools that are used during installation,
- Uninst The uninstaller and some cmd files generated during installation
to register your X# Extension inside VS 2015 and/or VS 2017.
It also contains cmd files created at install time to help generating
native images for the X# compiler.
- VOXPorter The VOXPorter
- XIDE The XIDE installer

During installation X# also copies files to the following folders:

For Visual Studio 2015

· c:\Program Files (x86)\MSBuild\XSharp
· c:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\Extensions\XSharp

© 2015- 2019 XSharp BV

 83 XSharp Bandol

For Visual Studio 2017

· c:\Program Files (x86)\Microsoft Visual
Studio\2017\<Version>\Common7\IDE\Extensions\XSharp
· c:\Program Files (x86)\Microsoft Visual Studio\2017\<Version>\MSBuild\XSharp

For Visual Studio 2019

· c:\Program Files (x86)\Microsoft Visual
Studio\2019\<Version>\Common7\IDE\Extensions\XSharp
· c:\Program Files (x86)\Microsoft Visual Studio\2019\<Version>\MSBuild\XSharp

Registry
The installer will also write some changes to the registry:
· HKLM\Software\XSharp
· HKLM\Software\Microsoft\.NETFramework\v4.0.30319\AssemblyFoldersEx\XSharp
· HKCR\.ppo
· HKCR\.prg
· HKCR\.prgx
· HKCR\.vh
· HKCR\.xh
· HKCR\.xs
· HKCR\.xsproj
· HKCR\XSharpScript
· HKCR\XSharp.headerfile
· HKCR\XSharp.ppofile
· HKCR\XSharp.sourcefile

1.1.6 New language features

Below is a list of some of the most visible new language features in the Core language of
X#, compared to Visual Objects and Vulcan.
As you can see many new keywords were introduced, but these are positional: they will
also be recognized as Identifiers on other places, so there is very little chance that you will
have to make changes to avoid naming conflicts.
FEATURE Description
The VO Define is back again in X#. It
DEFINE <id> := <Expression> will be compiled into a constant of the
Globals class, the same class in which
all Functions and Methods are
implemented. The biggest advantage of
a DEFINE over the preprocessor
DEFINEs in Vulcan.NET is that there is
no longer a chance that a DEFINE with
the same name as a Method, Property
or Variable will lead to
incomprehensible compiler errors.

© 2015- 2019 XSharp BV

 X# Documentation 84

FEATURE Description
The STATIC modifier for USING (note
USING STATIC <Name> that the # sign is no longer needed)
allows you to name a static class.
When you do so you can then use the
methods of this class as functions. For
example:
USING STATIC System.Console
FUNCTION Start as VOID
WriteLine("X# is cool!")
RETURN

The USING block allows you to control

BEGIN USING <Var> the lifetime of a variable. If <Var> has a
<Statements> destructor then it will be automatically
END [USING] destructed once the block has finished

The SWITCH statement generates a

SWITCH <Expression> more efficient jump structure than the
CASE <Const> DO CASE command. Also the
<Statements> expression is only evaluated once.
CASE <Const2>
CASE <Const3>
<Statements>
OTHERWISE
<Statements>
END [SWITCH]

Allows unsafe code in the context of

BEGIN UNSAFE this block , regardless of the compiler
<Statements> setting for the project as a whole.
END [UNSAFE]

The statements inside the block will

BEGIN CHECKED have checked conversions, regardless
<Statements> of the compiler setting for the project as
END [CHECKED] a whole.

Also allowed as expression

x := CHECKED(y)

The statements inside the block will

BEGIN UNCHECKED have unchecked conversions,
<Statements> regardless of the compiler setting for
END [UNCHECKED] the project as a whole.

Also allowed as expression

© 2015- 2019 XSharp BV

85 XSharp Bandol

FEATURE Description

x := UNCHECKED(y)

This is a synonym for LOCAL IMPLIED

VAR <Identifier> := <Expression>

Creating Generic classes is now

CLASS <Id> < <ParamName> > WHERE supported in X#, with all the features
<TypeConstraints> that C# also has For example
<Classmembers> CLASS MyList<T> WHERE T IS CLASS
END [CLASS] ..
END CLASS
or
CLASS MyList<T> WHERE T IS
ICustomer, NEW()
..
END CLASS

The ASYNC AWAIT infratructure is fully

ASYNC - AWAIT available inside X#

Allows to check an expression for a

<Expression> IS <Type> type. Can be used in stead of
IsInstanceOf() and will perform better

Conditional access for properties,

Conditional Access Operator ? methods etc. For example
<Expression> ? <Expression> nCount := MyList?:Count
This translates to something like:
VAR temp := MyList
IF temp != NULL
nCount := temp:Count
ENDIF
The expression on the Left hand side of
the Questionmark will be evaluated only
once !
The default operator allows you to inline
<Expression> DEFAULT <Expression> a check for NULL:
lResult := Foo() DEFAULT Bar()
This translates to the same as
lResult := Foo()
IF lResult == NULL
lResult := Bar()
ENDIF
Foo() will be evaluated only once. And
only when the result is NULL then Bar()
will be evaluated.

© 2015- 2019 XSharp BV

 X# Documentation 86

FEATURE Description
Tells the compiler to generate code that
y := CHECKED(x) checks for overflow

Tells the compiler to generate code that

y := UNCHECKED(x) does NOT check for overflow

The full LINQ feature set will be

LINQ Query expressions are now supported by X#:
supported: FROM LET WHERE JOIN ORDER BY EQUALS
VAR CustQuery = FROM Cust in INTO
Customers ;
WHERE Cust.City = "Athens" ;
ORDER BY Cust.Zipcode Select Cust

Can be used in a method declared as

YIELD RETURN <Value> Enumerator of a type. This will instruct
the compiler to automatically generate
a class that implemented an
enumerator and return to the calling
code directly on the YIELD RETURN
line. The next time the Iterator is called
the code will remember where the code
was the previous time it was executed
and will continue on the next statement
after the YIELD RETURN line.

1.1.6.1 Anonymous Methods

An example of an Anonymous Method Expression (AME) (note the DELEGATE keyword):
Note that the body of the that you can have :
1. A single Expression
2. An Expression List
3. A statement List
The first 2 require the expression(s) to be on the same line as the opening Curly { . Of
course you can use the statement continuation character ; to tell the compiler that you
have spread the statement over more than one line.
The last one requires the statements in the list to be on separate lines and the closing
Curly } must also be on a separate line. This is shown in the example below.

USING System.Windows.Forms
FUNCTION Start() AS VOID
TestAnonymous()
RETURN

FUNCTION TestAnonymous() AS VOID

© 2015- 2019 XSharp BV

 87 XSharp Bandol

LOCAL oForm AS Form

oForm := Form{}
oForm:Text := "Click me to activate the anonymous method"
oForm:Click += DELEGATE(o AS System.Object, e AS System.EventArgs ) {
System.Windows.Forms.MessageBox.Show("Click 1!")
System.Windows.Forms.MessageBox.Show("Click 2!")
}
oForm:ShowDialog()
RETURN

1.1.6.2 Anonymous Types

Anonymous types provide a convenient way to encapsulate a set of read-only properties
into a single object without having to explicitly define a type first.
The type name is generated by the compiler and is not available at the source code level.
The type of each property is inferred by the compiler.

The syntax for an anonymous class is :

VAR o := CLASS { Name := "test", Value := "something" }

In LINQ this may lead to:

VAR result := from c in db.Customers where c.Orders.Count > 0 ;

select CLASS{ ID := C.CustomerID, Name := C.CustomerName, OrderCount :=
C.Orders.Count}

In this case the object will have the properties ID, Name and OrderCount (all explicitely
given)

If you select named properties from another object you can omit the <Name> := part. In
that case the compiler will simply use the same name:

VAR result := from c in db.Customers where c.Orders.Count > 0 ;

select CLASS{ C.CustomerID, C.CustomerName, OrderCount := C.Orders.Count}

In this case the anonymous class will have the properties CustomerID, CustomerName
(inherited from C) and OrderCount (explicitely given)

Anonymous types contain one or more public read-only properties. No other kinds of class
members, such as methods or events, are valid.
The expression that is used to initialize a property cannot be null, an anonymous function,
or a pointer type.

The most common scenario is to initialize an anonymous type with properties from
another type. In the following example, assume that a class exists that is named Product.

© 2015- 2019 XSharp BV

 X# Documentation 88

Class Product includes Color and Price properties, together with other properties that you
are not interested in. Variable products is a collection of Product objects. The anonymous
type declaration starts with the new keyword. The declaration initializes a new type that
uses only two properties from Product. This causes a smaller amount of data to be
returned in the query.

If you do not specify member names in the anonymous type, the compiler gives the
anonymous type members the same name as the property being used to initialize them.
You must provide a name for a property that is being initialized with an expression, as
shown in the previous example. In the following example, the names of the properties of
the anonymous type are Color and Price.

var productQuery := ;
from prod in products ;
select CLASS { prod:Color, prod:Price }

foreach var v in productQuery

Console.WriteLine("Color={0}, Price={1}", v:Color, v:Price)
next

Typically, when you use an anonymous type to initialize a variable, you declare the
variable as an implicitly typed local variable by using var. The type name cannot be
specified in the variable declaration because only the compiler has access to the
underlying name of the anonymous type.

Remarks
Anonymous types are class types that derive directly from object, and that cannot be cast
to any type except object. The compiler provides a name for each anonymous type,
although your application cannot access it. From the perspective of the common language
runtime, an anonymous type is no different from any other reference type.

If two or more anonymous object initializers in an assembly specify a sequence of

properties that are in the same order and that have the same names and types, the
compiler treats the objects as instances of the same type. They share the same compiler-
generated type information.

You cannot declare a field, a property, an event, or the return type of a method as having
an anonymous type. Similarly, you cannot declare a formal parameter of a method,
property, constructor, or indexer as having an anonymous type. To pass an anonymous
type, or a collection that contains anonymous types, as an argument to a method, you can
declare the parameter as type object. However, doing this defeats the purpose of strong
typing. If you must store query results or pass them outside the method boundary,
consider using an ordinary named struct or class instead of an anonymous type.

Because the Equals and GetHashCode methods on anonymous types are defined in
terms of the Equals and GetHashCode methods of the properties, two instances of the
same anonymous type are equal only if all their properties are equal.

© 2015- 2019 XSharp BV

 89 XSharp Bandol

1.1.6.3 ASTYPE
We have added a new keyword that allows you to cast a value to a type with type, just like
the C# "as" keyword:

FUNCTION Test (oVar as ParentClass)

LOCAL oChild := oVar ASTYPE ChildClass
IF (oChild != NULL_OBJECT)
DoSomething()
ENDIF

1.1.6.4 ASYNC - AWAIT

//
// This example shows that you can call an async task and wait for it to
finish
// The result of the async task (in this case the size of the file that has
been downloaded)
// will be come available when the task has finished
// The calling code (The Start()) function will not have to wait until the
async task has
// finished. That is why the line "2....." will be printed before the
results from TestClass.DoTest()
// The sample also shows an event and displays the thread id's. You can see
that the DownloadFileTaskAsync() method
// starts multiple threads to download the web document in multiple pieces.

USING System
USING System.Threading.Tasks

FUNCTION Start() AS VOID

? "1. calling long process"
TestClass.DoTest()
? "2. this should be printed while processing"
Console.ReadKey()

CLASS TestClass
STATIC PROTECT oLock AS OBJECT // To make sure we synchronize the
writing to the screen
STATIC CONSTRUCTOR
oLock := OBJECT{}

ASYNC STATIC METHOD DoTest() AS VOID

LOCAL Size AS INT64
Size := AWAIT LoooongProcess()
? "3. returned from long process"
? Size, " Bytes downloaded"

ASYNC STATIC METHOD LoooongProcess() AS Task<INT64>

VAR WebClient := System.Net.WebClient{}
VAR FileName := System.IO.Path.GetTempPath()+"temp.txt"
webClient:DownloadProgressChanged += OnDownloadProgress
webClient:Credentials :=
System.Net.CredentialCache.DefaultNetworkCredentials

© 2015- 2019 XSharp BV

 X# Documentation 90

AWAIT
webClient:DownloadFileTaskAsync("http://www.xsharp.info/index.php",
FileName)
VAR dirInfo :=
System.IO.DirectoryInfo{System.IO.Path.GetTempPath()}
VAR Files := dirInfo:GetFiles("temp.txt")
IF Files:Length > 0
System.IO.File.Delete(FileName)
RETURN Files[1]:Length
ENDIF
RETURN 0

STATIC METHOD OnDownloadProgress (sender AS OBJECT, e AS

System.Net.DownloadProgressChangedEventArgs) AS VOID
BEGIN LOCK oLock
? String.Format("{0,3} % Size: {1,8:N0} Thread {2}",
100*e:BytesReceived / e:TotalBytesToReceive , e:BytesReceived, ;
System.Threading.Thread.CurrentThread:ManagedThreadId)
END LOCK
RETURN

END CLASS

1.1.6.5 BEGIN CHECKED

FUNCTION Start() AS VOID

LOCAL d AS DWORD
LOCAL n AS INT

d := UInt32.MaxValue
? "Initial value of d:", d

BEGIN UNCHECKED
// arithmetic operations inside an UNCHECKED block will not produce
// overflow exceptions on arithmetic conversions and operations,
// no matter if overflow checking is enabled application-wide or not
n := (INT)d
? "Value of n after conversion:", n
d ++
? "Value of d after increasing it:", d
END UNCHECKED

d := UInt32.MaxValue
BEGIN CHECKED
// arithmetic operations inside a CHECKED block always do
// overflow checking and throw exceptions if overflow is detected
TRY
n := (INT)d
d ++
CATCH e AS Exception
? "Exception thrown in CHECKED operation:", e:Message
END TRY
END CHECKED
Console.ReadLine()

© 2015- 2019 XSharp BV

 91 XSharp Bandol

RETURN

1.1.6.6 BEGIN FIXED

The new FIXED modifier and BEGIN FIXED .. END FIXED keywords allow you to tell the
.Net runtime that you do not want a variable to be moved by the Garbage collector.

UNSAFE FUNCTION Start AS VOID

VAR s := "SDRS"
BEGIN FIXED LOCAL p := s AS CHAR PTR
VAR i := 0
WHILE p[i] != 0
p[i++]++
END
END FIXED
Console.WriteLine(s)
Console.Read()
RETURN

As you can see the BEGIN FIXED statement requires a local variable declaration. The
contents of this local (in the example above a CHAR PTR) will be excluded from garbage
collection inside the block.

Please note:
The FIXED keyword and the example above should be used with extreme care. Strings in
.Net are immutable. You normally should not manipulate strings this way !

1.1.6.7 BEGIN UNCHECKED

FUNCTION Start() AS VOID

LOCAL d AS DWORD
LOCAL n AS INT

d := UInt32.MaxValue
? "Initial value of d:", d

BEGIN UNCHECKED
// arithmetic operations inside an UNCHECKED block will not produce
// overflow exceptions on arithmetic conversions and operations,
// no matter if overflow checking is enabled application-wide or not
n := (INT)d
? "Value of n after conversion:", n
d ++
? "Value of d after increasing it:", d
END UNCHECKED

d := UInt32.MaxValue
BEGIN CHECKED
// arithmetic operations inside a CHECKED block always do
// overflow checking and throw exceptions if overflow is detected
TRY
n := (INT)d

© 2015- 2019 XSharp BV

 X# Documentation 92

d ++
CATCH e AS Exception
? "Exception thrown in CHECKED operation:", e:Message
END TRY
END CHECKED
Console.ReadLine()
RETURN

1.1.6.8 BEGIN UNSAFE

Enter topic text here.

1.1.6.9 BEGIN USING

//
// XSharp allows you to not only use the using statement to link to
namespaces
// You can also link to a static class and call the methods in this class as
if they are functions.
// The functions WriteLine and ReadKey() in the following code are actually
resolved as System.Console.WriteLine()
// and System.Console.ReadKey()
// Finally there is also the BEGIN USING .. END USING construct which
controls the lifetime of a variable
// At the end of the block the Variable will be automatically disposed.
USING System
USING STATIC System.Console

FUNCTION Start() AS VOID

WriteLine("Before Using Block")
WriteLine("------------------")
BEGIN USING VAR oTest := Test{}
oTest:DoSomething()
END USING
WriteLine("------------------")
WriteLine("After Using Block")
ReadKey()

CLASS Test IMPLEMENTS IDisposable

CONSTRUCTOR()
Console.WriteLine("Test:Constructor()")

METHOD DoSomething() AS VOID

Console.WriteLine("Test:DoSomething()")

METHOD Dispose() AS VOID

Console.WriteLine("Test:Dispose()")

END CLASS

© 2015- 2019 XSharp BV

 93 XSharp Bandol

1.1.6.10 Collection Initializers

Collection initializers allow you to fill a collection with a list of values.
In the background the compiler will generate code that calls the Add method of the
collection.
The example below creates a list of Integers, Strings and Persons.

USING System
USING System.Collections.Generic
USING System.Linq
USING System.Text

FUNCTION Start() AS VOID

LOCAL oList AS List<Int>
// The next line creates the collection and adds 5 elements
// Note the double curly braces:
// The first pair calls the default constructor of the List<> Class
// The second pair of curly braces surrounds the list of values
Console.WriteLine("Collection Initializers")
oList := List<Int>{} {1,2,3,4,5}
FOREACH VAR i IN oLIst
Console.WriteLine(i)
NEXT
VAR oCompass := List<String>{}{"North", "East", "South", "West"}
FOREACH VAR sDirection in oCompass
Console.WriteLine(sDirection)
NEXT
Console.ReadLine()
// Now an example of an Object Initializer
// Note that the object has no constructor
// We are assigning the values directly to the properties
// This will only work if there are public properties
// Again there are double curly braces:
// The first pair calls the default constructor of the Person class
// The second pair of curly braces surrounds the list of name-value
pairs

Console.WriteLine("Object Initializer")
VAR oPerson := Person{}{FirstName := "John", LastName := "Smith"}
? oPerson:Name
Console.ReadLine()
// Combine the two
Var oPeople := List<Person> {} {;
Person{}{FirstName := "John", LastName :=
"Smith"}, ;
Person{}{FirstName := "Jane", LastName :=
"Doe"} ;
}
Console.WriteLine("Collection and Object Initializers")

FOREACH var oP in oPeople

Console.WriteLine(oP:Name)
NEXT
Console.ReadLine()
RETURN

PUBLIC CLASS Person

© 2015- 2019 XSharp BV

 X# Documentation 94

PROPERTY FirstName AS STRING AUTO

PROPERTY LastName AS STRING AUTO
PROPERTY Name AS STRING GET FirstName+" "+LastName
END CLASS

1.1.6.11 Conditional Access Expression

//
// This example shows various new expression formats
//
using System.Collections.Generic

Function Start() as void

VAR oNone := Person{"No", "Parent"}

FOREACH VAR oValue in GetList()

if oValue IS STRING // Value IS Type
? (String) oValue
ELSEIF oValue IS INT
? (Int) oValue
ELSEIF oValue IS DateTime
? (DateTime) oValue
ELSEIF oValue IS Person
LOCAL oPerson as Person
oPerson := (Person) oValue
? oPerson:FirstName, oPerson:LastName
// Value DEFAULT Value2 . When Value IS NULL then Value2 will be used
oPerson := oPerson:Parent DEFAULT oNone
? "Parent: ", oPerson:FirstName, oPerson:LastName
ENDIF
NEXT
LOCAL oEmptyPerson as Person
LOCAL sName as STRING
oEmptyPerson := GetAPerson()
sName := oEmptyPerson?:FirstName // Conditional Access: This
will not crash, even when Person is a NULL_OBJECT
? sName DEFAULT "None"
Console.ReadLine()
RETURN

FUNCTION GetList() AS List<OBJECT>

VAR aList := List<OBJECT>{}
aList:Add(DateTime.Now)
aList:Add("abcdefg")
aList:Add(123456)
VAR oPerson := Person{"John", "Doe"}
aList:Add(oPerson)
VAR oChild := Person{"Jane", "Doe"}
oChild:Parent := oPerson
aList:Add(oChild)
RETURN aList

CLASS Person
EXPORT FirstName AS STRING

© 2015- 2019 XSharp BV

 95 XSharp Bandol

EXPORT LastName as STRING

EXPORT Parent as Person
CONSTRUCTOR(First as STRING, Last as STRING)
FirstName := First
LastName := Last

END CLASS

FUNCTION GetAPerson() as Person

RETURN NULL_OBJECT

1.1.6.12 Creating Generic Classes

Stack Example
This example shows that we can now create generic classes with X# !
In the Stack class the T parameter will be replaced with a type at compile time.

/*
Stack Example - Written by Robert van der Hulst
This example shows that we can now create generic classes with X# !
Note: Compile with the /AZ option
*/

USING System.Collections.Generic
USING STATIC System.Console

FUNCTION Start AS VOID

LOCAL oStack AS Stack<INT>
LOCAL i AS LONG
TRY
oStack := Stack<INT>{25}
WriteLine("Created a stack with {0} items",oStack:Capacity)
WriteLine("Pushing 10 items")
FOR I := 1 TO 10
oStack:Push(i)
NEXT
WriteLine("Popping the stack until it is empty")
i := 0
WHILE oStack:Size > 0
i += 1
WriteLine(oStack:Pop())
END
WriteLine("{0} Items popped from the stack",i)
WriteLine("Press Enter")
ReadLine()
WriteLine("The next line pops from an empty stack and throws an
exception")
ReadLine()
WriteLine(oStack:Pop())
CATCH e AS Exception
WriteLine("An exception was catched: {0}", e:Message)
END TRY
WriteLine("Press Enter to Exit")

© 2015- 2019 XSharp BV

 X# Documentation 96

ReadLine()
RETURN

CLASS Stack<T> WHERE T IS STRUCT, NEW()

PROTECT _Items AS T[]
PROTECT _Size AS INT
PROTECT _Capacity AS INT
PROPERTY Size AS INT GET _Size
PROPERTY Capacity AS INT GET _Capacity

CONSTRUCTOR()
SELF(100)

CONSTRUCTOR(nCapacity AS INT)
_Capacity := nCapacity
_Items := T[]{nCapacity}
_Size := 0
RETURN

PUBLIC METHOD Push( item AS T) AS VOID

IF _Size >= _Capacity
THROW StackOverFlowException{}
ENDIF
_Items[_Size] := item
_Size++
RETURN

PUBLIC METHOD Pop( ) AS T

_Size--
IF _Size >= 0
RETURN _Items[_Size]
ELSE
_Size := 0
THROW Exception{"Cannot pop from an empty stack"}
ENDIF
END CLASS

1.1.6.13 DEFAULT Expressions

//
// This example shows various new expression formats
//
using System.Collections.Generic

Function Start() as void

VAR oNone := Person{"No", "Parent"}

FOREACH VAR oValue in GetList()

if oValue IS STRING // Value IS Type
? (String) oValue
ELSEIF oValue IS INT
? (Int) oValue
ELSEIF oValue IS DateTime
? (DateTime) oValue

© 2015- 2019 XSharp BV

 97 XSharp Bandol

ELSEIF oValue IS Person

LOCAL oPerson as Person
oPerson := (Person) oValue
? oPerson:FirstName, oPerson:LastName
// Value DEFAULT Value2 . When Value IS NULL then Value2 will be used
oPerson := oPerson:Parent DEFAULT oNone
? "Parent: ", oPerson:FirstName, oPerson:LastName
ENDIF
NEXT
LOCAL oEmptyPerson as Person
LOCAL sName as STRING
oEmptyPerson := GetAPerson()
sName := oEmptyPerson?:FirstName // Conditional Access: This
will not crash, even when Person is a NULL_OBJECT
? sName DEFAULT "None"
Console.ReadLine()
RETURN

FUNCTION GetList() AS List<OBJECT>

VAR aList := List<OBJECT>{}
aList:Add(DateTime.Now)
aList:Add("abcdefg")
aList:Add(123456)
VAR oPerson := Person{"John", "Doe"}
aList:Add(oPerson)
VAR oChild := Person{"Jane", "Doe"}
oChild:Parent := oPerson
aList:Add(oChild)
RETURN aList

CLASS Person
EXPORT FirstName AS STRING
EXPORT LastName as STRING
EXPORT Parent as Person
CONSTRUCTOR(First as STRING, Last as STRING)
FirstName := First
LastName := Last

END CLASS

FUNCTION GetAPerson() as Person

RETURN NULL_OBJECT

1.1.6.14 EVENT (Add and Remove)

XSharp now supports an extended Event syntax. Both a single line syntax is supported as
a multi line:

Old style syntax (compatible with Vulcan)

[Attributes] [Modifiers] EVENT [<ExplicitInterface>.] <Id> AS <Type> //

Old Style

© 2015- 2019 XSharp BV

 X# Documentation 98

Single Line syntax with explicit expressions

[Attributes] [Modifiers] EVENT [<ExplicitInterface>.] <Id> AS <Type> [ADD

<ExpressionList] [REMOVE <ExpressionList] // Single Line

Multi line syntax with explicit expressions

[Attributes] [Modifiers] EVENT [<ExplicitInterface>.] <Id> AS <Type> //

Multi line

ADD
<Statements>
END [ADD]
REMOVE
<Statements>
END [REMOVE]
END [EVENT]

Example

USING System.Collections.Generic
FUNCTION Start AS VOID
LOCAL e AS EventsExample
e := EventsExample{}
e:Event1 += TestClass.DelegateMethod
e:Event1 += TestClass.DelegateMethod
e:Event1 -= TestClass.DelegateMethod // added 2, removed 1, should be
called once
e:Event2 += TestClass.DelegateMethod
e:Event2 += TestClass.DelegateMethod
e:Event2 -= TestClass.DelegateMethod // added 2, removed 1, should be
called once
e:Event3 += TestClass.DelegateMethod
e:RaiseEvent1("This is a test through a multi line event definition")
e:RaiseEvent2("This is a test through a single line event definition")
e:RaiseEvent3("This is a test through an old style event definition")
Console.WriteLine("Press a Key")
Console.ReadLine()

DELEGATE EventHandler (s AS STRING) AS VOID

CLASS TestClass
STATIC METHOD DelegateMethod(s AS STRING ) AS VOID
Console.WriteLine( s)
END CLASS

© 2015- 2019 XSharp BV

99 XSharp Bandol

CLASS EventsExample
PRIVATE eventsTable AS Dictionary<STRING, System.Delegate>
PRIVATE CONST sEvent1 := "Event1" AS STRING
PRIVATE CONST sEvent2 := "Event2" AS STRING
CONSTRUCTOR()
eventsTable := Dictionary<STRING, System.Delegate>{}
eventsTable:Add(sEvent1,NULL_OBJECT)
eventsTable:Add(sEvent2,NULL_OBJECT)

// Multiline definition
EVENT Event1 AS EventHandler
ADD
BEGIN LOCK eventsTable
eventsTable[sEvent1] := ((EventHandler)
eventsTable[sEvent1]) + value
END LOCK
Console.WriteLine(__ENTITY__ + " "+value:ToString())
END
REMOVE
BEGIN LOCK eventsTable
eventsTable[sEvent1] := ((EventHandler)
eventsTable[sEvent1]) - value
END LOCK
Console.WriteLine(__ENTITY__+ " "+value:ToString())
END
END EVENT

// Single Line defintion on multilpe lines with semi colons, for better
reading !
EVENT Event2 AS EventHandler ;
ADD eventsTable[sEvent2] := ((EventHandler)
eventsTable[sEvent2]) + value ;
REMOVE eventsTable[sEvent2] := ((EventHandler)
eventsTable[sEvent2]) - value

// Old style definition

EVENT Event3 AS EventHandler

METHOD RaiseEvent1(s AS STRING) AS VOID

VAR handler := (EventHandler) eventsTable[sEvent1]
IF handler != NULL
handler(s)
ENDIF

METHOD RaiseEvent2(s AS STRING) AS VOID

VAR handler := (EventHandler) eventsTable[sEvent2]
IF handler != NULL
handler(s)
ENDIF

METHOD RaiseEvent3(s AS STRING) AS VOID

IF SELF:Event3 != NULL
Event3(s)
ENDIF
END CLASS

© 2015- 2019 XSharp BV

 X# Documentation 100

1.1.6.15 Expression IS Type

//
// This example shows various new expression formats
//
using System.Collections.Generic

Function Start() as void

VAR oNone := Person{"No", "Parent"}

FOREACH VAR oValue in GetList()

if oValue IS STRING // Value IS Type
? (String) oValue
ELSEIF oValue IS INT
? (Int) oValue
ELSEIF oValue IS DateTime
? (DateTime) oValue
ELSEIF oValue IS Person
LOCAL oPerson as Person
oPerson := (Person) oValue
? oPerson:FirstName, oPerson:LastName
// Value DEFAULT Value2 . When Value IS NULL then Value2 will be used
oPerson := oPerson:Parent DEFAULT oNone
? "Parent: ", oPerson:FirstName, oPerson:LastName
ENDIF
NEXT
LOCAL oEmptyPerson as Person
LOCAL sName as STRING
oEmptyPerson := GetAPerson()
sName := oEmptyPerson?:FirstName // Conditional Access: This
will not crash, even when Person is a NULL_OBJECT
? sName DEFAULT "None"
Console.ReadLine()
RETURN

FUNCTION GetList() AS List<OBJECT>

VAR aList := List<OBJECT>{}
aList:Add(DateTime.Now)
aList:Add("abcdefg")
aList:Add(123456)
VAR oPerson := Person{"John", "Doe"}
aList:Add(oPerson)
VAR oChild := Person{"Jane", "Doe"}
oChild:Parent := oPerson
aList:Add(oChild)
RETURN aList

CLASS Person
EXPORT FirstName AS STRING
EXPORT LastName as STRING
EXPORT Parent as Person
CONSTRUCTOR(First as STRING, Last as STRING)
FirstName := First
LastName := Last

END CLASS

FUNCTION GetAPerson() as Person

© 2015- 2019 XSharp BV

 101 XSharp Bandol

RETURN NULL_OBJECT

1.1.6.16 Initializers

USING System
USING System.Collections.Generic
USING System.Linq
USING System.Text

FUNCTION Start() AS VOID

LOCAL oList AS List<Int>
// The next line creates the collection and adds 5 elements
// Note the double curly braces:
// The first pair calls the default constructor of the List<> Class
// The second pair of curly braces surrounds the list of values
Console.WriteLine("Collection Initializers")
oList := List<Int>{} {1,2,3,4,5}
FOREACH VAR i IN oLIst
Console.WriteLine(i)
NEXT
VAR oCompass := List<String>{}{"North", "East", "South", "West"}
FOREACH VAR sDirection in oCompass
Console.WriteLine(sDirection)
NEXT
Console.ReadLine()
// Now an example of an Object Initializer
// Note that the object has no constructor
// We are assigning the values directly to the properties
// This will only work if there are public properties
// Again there are double curly braces:
// The first pair calls the default constructor of the Person class
// The second pair of curly braces surrounds the list of name-value
pairs

Console.WriteLine("Object Initializer")
VAR oPerson := Person{}{FirstName := "John", LastName := "Smith"}
? oPerson:Name
Console.ReadLine()
// Combine the two
Var oPeople := List<Person> {} {;
Person{}{FirstName := "John", LastName :=
"Smith"}, ;
Person{}{FirstName := "Jane", LastName :=
"Doe"} ;
}
Console.WriteLine("Collection and Object Initializers")

FOREACH var oP in oPeople

Console.WriteLine(oP:Name)
NEXT
Console.ReadLine()
RETURN

PUBLIC CLASS Person

© 2015- 2019 XSharp BV

 X# Documentation 102

PROPERTY FirstName AS STRING AUTO

PROPERTY LastName AS STRING AUTO
PROPERTY Name AS STRING GET FirstName+" "+LastName
END CLASS

1.1.6.17 Interpolated Strings

Interpolated strings is a feature that allows you to embed local variables, instance
variables or other expressions inside literal strings.
X# supports two kinds of interpolated strings:

1. Normal Interpolated strings: i"...."

This works like a normal X# string but with an embedded expression:

FUNCTION Start AS VOID

LOCAL Who AS STRING
Who := "World"
Console.Writeline( i"Hello {Who}")
Console.Read()
RETURN

2. Extended Interpolated strings: ie"..." and ei"...."

This is a combination of an interpolated string and an extended string. In the example
below the \t will be replaced with a tab character.

FUNCTION Start AS VOID

LOCAL Who AS STRING
Who := "World"
Console.Writeline( ie"Hello\t{Who}")
Console.Read()
RETURN

Notes
The expression parsing inside the interpolated strings recognizes:
· SELF:
· Local variables, Member variables and Properties with SELF: prefix and without this
prefix
· Other expressions must be in C# syntax for now, using the dot (.) operator as send
operator.

The expression elements inside the string can use formatting notation just like the
String.Format() notation. For example:

© 2015- 2019 XSharp BV

 103 XSharp Bandol

FUNCTION Start AS VOID

LOCAL i AS INT
i := 42
Console.Writeline( i"Hello {i:x}") // i is printed in hex notation,
so Hello 2a
Console.Read()
RETURN

1.1.6.18 LINQ Query Expressions

The following example shows a couple of LINQ Queries in X#

USING System.Collections.Generic
USING System.Linq
USING STATIC System.Console

FUNCTION Start AS VOID

VAR oDev := GetDevelopers()
VAR oC := GetCountries()
VAR oAll := FROM D IN oDev ;
JOIN C IN oC ON D:Country EQUALS C:Name ;
ORDERBY D:LastName ;
SELECT CLASS {D:Name, D:Country, C:Region} //
Anonymous class !
// The type of oAll is
IOrderedEnumerable<<>f__AnonymousType0<Developer,Country>> // We prefer
the VAR keyword!

VAR oGreek := FROM Developer IN oDev ;

WHERE Developer:Country == "Greece" ;
ORDERBY Developer:LastName DESCENDING ;
SELECT Developer
// The type of oGreek is IOrderedEnumerable<Developer>
// We prefer the VAR keyword!

VAR oCount := FROM Developer IN oDev ;

GROUP Developer BY Developer:Country INTO NewGroup ;
ORDERBY NewGroup:Key SELECT NewGroup
// The type of oCount is IOrderedEnumerable<<IGrouping<string,Developer>>
// We prefer the VAR keyword!

WriteLine(e"X# does LINQ!\n")

WriteLine(e"All X# developers (country+lastname order)\n")
FOREACH VAR oDeveloper IN oAll
WriteLine("{0} in {1}, {2}",oDeveloper:Name, oDeveloper:Country,
oDeveloper:Region)
NEXT

WriteLine(e"\nGreek X# Developers (descending lastname)\n")

FOREACH oDeveloper AS Developer IN oGreek
WriteLine(oDeveloper:Name)
NEXT

© 2015- 2019 XSharp BV

 X# Documentation 104

WriteLine(e"\nDevelopers grouped per country\n")

FOREACH VAR country IN oCount

WriteLine(i"{country.Key}, {country.Count()} developer(s)")
FOREACH VAR oDeveloper IN country
WriteLine(" " + oDeveloper:Name)
NEXT
NEXT
WriteLine("Enter to continue")
ReadLine()
RETURN

FUNCTION GetDevelopers AS IList<Developer>

// This function uses a collection initializer for the List of Developers
// and Object initializers for the Developer Objects
VAR oList := List<Developer>{} { ;
Developer{}{ FirstName := "Chris", LastName :=
"Pyrgas", Country := "Greece"},;
Developer{}{ FirstName := "Robert", LastName :=
"van der Hulst", Country := "The Netherlands"},;
Developer{}{ FirstName := "Fabrice", LastName :=
"Foray", Country := "France"},;
Developer{}{ FirstName := "Nikos", LastName :=
"Kokkalis", Country := "Greece"} ;
}
RETURN oList

FUNCTION GetCountries AS IList<Country>

// This function uses a collection initializer for the List of Counties
// and Object initializers for the Country Objects
VAR oList := List<Country>{}{ ;
Country{} {Name := "Greece", Region := "South
East Europe"},;
Country{} {Name := "France", Region := "West
Europe"},;
Country{} {Name := "The Netherlands", Region :=
"North West Europe"} ;
}
RETURN oList

CLASS Developer
PROPERTY Name AS STRING GET FirstName + " " + LastName
PROPERTY FirstName AS STRING AUTO
PROPERTY LastName AS STRING AUTO
PROPERTY Country AS STRING AUTO
END CLASS

CLASS Country
PROPERTY Name AS STRING AUTO
PROPERTY Region AS STRING AUTO
END CLASS

© 2015- 2019 XSharp BV

 105 XSharp Bandol

1.1.6.19 NOP
The NOP keyword allows you to define a line of code that does nothing but satisfies the
compiler, so it will not complain about missing code.

// The NOP keyword is an empty statement.

// This tells the compiler that there is no code missing !
FUNCTION Start() AS VOID
LOCAL i as LONG
FOR i := 1 to 10
IF I % 2 == 0
Console.WriteLine(i)
ELSE
NOP // Nothing happens here. This tells the compiler that there
is no code missing !
ENDIF
NEXT
RETURN

1.1.6.20 Object Initializers

Object Initializers allow you to instantiate an object and assign values to its properties in
one line of code.
The example below uses object initializers to set the FirstName and LastName property of
the Person object

USING System
USING System.Collections.Generic
USING System.Linq
USING System.Text

FUNCTION Start() AS VOID

LOCAL oList AS List<Int>
// The next line creates the collection and adds 5 elements
// Note the double curly braces:
// The first pair calls the default constructor of the List<> Class
// The second pair of curly braces surrounds the list of values
Console.WriteLine("Collection Initializers")
oList := List<Int>{} {1,2,3,4,5}
FOREACH VAR i IN oLIst
Console.WriteLine(i)
NEXT
VAR oCompass := List<String>{}{"North", "East", "South", "West"}
FOREACH VAR sDirection in oCompass
Console.WriteLine(sDirection)
NEXT
Console.ReadLine()
// Now an example of an Object Initializer
// Note that the object has no constructor
// We are assigning the values directly to the properties
// This will only work if there are public properties
// Again there are double curly braces:
// The first pair calls the default constructor of the Person class

© 2015- 2019 XSharp BV

 X# Documentation 106

// The second pair of curly braces surrounds the list of name-value

pairs

Console.WriteLine("Object Initializer")
VAR oPerson := Person{}{FirstName := "John", LastName := "Smith"}
? oPerson:Name
Console.ReadLine()
// Combine the two
Var oPeople := List<Person> {} {;
Person{}{FirstName := "John", LastName :=
"Smith"}, ;
Person{}{FirstName := "Jane", LastName :=
"Doe"} ;
}
Console.WriteLine("Collection and Object Initializers")

FOREACH var oP in oPeople

Console.WriteLine(oP:Name)
NEXT
Console.ReadLine()
RETURN

PUBLIC CLASS Person

PROPERTY FirstName AS STRING AUTO
PROPERTY LastName AS STRING AUTO
PROPERTY Name AS STRING GET FirstName+" "+LastName
END CLASS

1.1.6.21 SWITCH

//
// The SWITCH statement is a replacement for the DO CASE statement
// The biggest difference is that the expression (in this case sDeveloper)
is only evaluated once.
// which will have a performance benefit over the DO CASE statement
// Empty statement lists for a CASE are allowed. In that case the labels
share the code (see CHRIS and NIKOS below)
//
// Please note that EXIT statements inside a switch are not allowed, however
RETURN, LOOP and THROW are allowed.
using System.Collections.Generic

Function Start() as void

FOREACH VAR sDeveloper in GetDevelopers()
SWITCH sDeveloper:ToUpper()
CASE "FABRICE"
? sDeveloper, "France"
CASE "CHRIS"
CASE "NIKOS"
? sDeveloper, "Greece"
CASE "ROBERT"
? sDeveloper, "The Netherlands"
OTHERWISE
? sDeveloper, "Earth"

© 2015- 2019 XSharp BV

 107 XSharp Bandol

END SWITCH
NEXT
Console.ReadKey()
RETURN

FUNCTION GetDevelopers as List<String>

VAR aList := List<String>{}
aList:AddRange(<string>{ "Chris", "Fabrice", "Nikos", "Robert" } )
RETURN aList

1.1.6.22 USING

//
// XSharp allows you to not only use the using statement to link to
namespaces
// You can also link to a static class and call the methods in this class as
if they are functions.
// The functions WriteLine and ReadKey() in the following code are actually
resolved as System.Console.WriteLine()
// and System.Console.ReadKey()
// Finally there is also the BEGIN USING .. END USING construct which
controls the lifetime of a variable
// At the end of the block the Variable will be automatically disposed.
USING System
USING STATIC System.Console

FUNCTION Start() AS VOID

WriteLine("Before Using Block")
WriteLine("------------------")
BEGIN USING VAR oTest := Test{}
oTest:DoSomething()
END USING
WriteLine("------------------")
WriteLine("After Using Block")
ReadKey()

CLASS Test IMPLEMENTS IDisposable

CONSTRUCTOR()
Console.WriteLine("Test:Constructor()")

METHOD DoSomething() AS VOID

Console.WriteLine("Test:DoSomething()")

METHOD Dispose() AS VOID

Console.WriteLine("Test:Dispose()")

END CLASS

© 2015- 2019 XSharp BV

 X# Documentation 108

1.1.6.23 VAR

//
// The VAR keyword has been added to the language because in many situations
// the result of an expression will be directly assigned to a local, and the
expression
// will already describe the type of the variable
// VAR is a synonym for LOCAL IMPLIED in Vulcan
using System.Collections.Generic

FUNCTION Start AS VOID

// In the next line the compiler "knows" that today is a DateTime
VAR today := System.DateTime.Now
? today

// In the next line the compiler "knows" that text is a String

VAR text := Convert.ToString(123)
? text

// In the next line the compiler "knows" that s is a string

FOREACH VAR s in GetList()
? s
NEXT

Console.ReadLine()

RETURN

FUNCTION GetList AS List<String>

VAR aList := List<String>{}
aList:Add("abc")
aList:Add("def")
aList:Add("ghi")
return aList

1.1.6.24 YIELD

using System.Collections.Generic

// The Yield return statement allows you to create code that returns a
// collection of values without having to create the collection in memory
first.
// The compiler will create code that "remembers" where you were inside the
// loop and returns to that spot.
FUNCTION Start AS VOID
FOREACH nYear AS INT IN GetAllLeapYears(1896, 2040)
? "Year", nYear, "is a leap year."
NEXT
Console.ReadLine()
RETURN

FUNCTION GetAllLeapYears(nMin AS INT, nMax AS INT) AS IEnumerable<INT>

FOR LOCAL nYear := nMin AS INT UPTO nMax
IF nYear % 4 == 0 .and. (nYear % 100 != 0 .or. nYear % 400 == 0)

© 2015- 2019 XSharp BV

 109 XSharp Bandol

YIELD RETURN nYear

END IF
IF nYear == 2012
YIELD EXIT // Exit the loop
ENDIF
NEXT

1.1.6.25 XBase++ class declarations

As of build 2.0.0.8 X# also support XBase++ style class declarations. Of course we have
added strong typing to the language definition to make the code run faster.
Full documentation will be included in one of the next builds.
The code below shows the XBase++ support in action

CLASS Developer
class var list as array // class vars are like static variables.
class VAR nextid as int
class var random as Random
PROTECTED:
VAR id as int NOSAVE // the Nosave clause will mark the field
with the [NonSerialized] attribute
EXPORTED:
VAR FirstName as string
VAR LastName as string
VAR Country as string
// The inline prefix in the next line is needed when declaring a method
inside the class .. endclass block.
INLINE METHOD initClass() // The XBase++ equivalent of the Static
constructor
list := {}
nextid := 1
random := Random{}
RETURN

INLINE METHOD Init(cFirst as string , cLast as string, cCountry as

string) // Init is the constructor
// you can use :: instead of SELF:
::FirstName := cFirst
::LastName := cLast
::Country := cCountry
::id := nextid
nextid += 1
aadd(list, SELF)
RETURN

INLINE Method SayHello() as STRING

if ::Age < 40
RETURN "Hello, I am " + ::FirstName+ " from "+::Country
else
RETURN "Hello, I am mr " + ::LastName+ " from "+::Country+" but you
can call me "+::FirstName
endif

© 2015- 2019 XSharp BV

 X# Documentation 110

INLINE METHOD FullName() as string

RETURN ::FirstName + " " + ::LastName

INLINE METHOD Fire() as logic

local nPos as dword
nPos := Ascan(list, SELF)
if nPos > 0
aDel(list, nPos)
ASize(list, aLen(list)-1)
return true
endif
return false
// the next block contains forward declarations. The methods has to be
declared below the class .. endclass block

// SYNC method makes sure that only one thread can run this code at the
same time
SYNC METHOD LivesIn
// ACCESS indicates a PROPERTY GET
// ASSIGN indicates a PROPERTY SET
ACCESS CLASS METHOD Length as dword
ACCESS METHOD Age as int
ENDCLASS

// This is the implementation of LivesIn. SYNC does not have to be repeated

here
METHOD LivesIn(cCountry as string) as logic
return lower(::Country) == lower(cCountry)

// This is the implementation of the AGE Property. ACCESS does not have to
be repeated here
METHOD Age() as int
local nAge as int
nAge := random:@@Next(25,60)
return nAge

// This is the implementation of the Length Property. ACCESS does not have
to be repeated. CLASS however must be specified.
CLASS METHOD Length as dwor
return ALen(list)

// the entry point is Main() like in XBase++

function Main(a) as int
local oDeveloper as Developer
local aDevs := {} as array
local i as int
if PCount() > 0
? "Parameters"
for i := 1 to PCount()
? _GetFParam(i)
next
endif
// create a new object with XBase++ Syntax. Developer{} would have worked
as well.
aadd(aDevs, Developer():New("Chris", "Pyrgas", "Greece"))
aadd(aDevs, Developer():New("Nikos", "Kokkalis","Greece"))
aadd(aDevs, Developer():New("Fabrice", "Foray","France"))

© 2015- 2019 XSharp BV

 111 XSharp Bandol

aadd(aDevs, Developer():New("Robert", "van der Hulst","The Netherlands"))

? "# of devs before", Developer.Length
for i := 1 to alen(aDevs)
oDeveloper := aDevs[i]
? "Fields", oDeveloper:FirstName, oDeveloper:LastName, oDeveloper:Country
? "FullName",oDeveloper:FullName()
? oDeveloper:SayHello()
? "Greece ?", oDeveloper:LivesIn("Greece")
? "Fired", oDeveloper:Fire()
? "# of devs after firing", oDeveloper:FirstName, Developer.Length
next
_wait()
RETURN PCount()

1.1.7 Licensing
XSharp is FREE Software. Of course that does not mean that you can do with it whatever
you want. We have set a couple of rules that determine what you can and cannot do with
our software, so our software is released under a license.
In an ideal world we would have published all of our source code and binaries under a very
open license agreement, such as the Apache License, just like how the Roslyn code is
published.
However the reality is that there are people on this world that would like to take our source
code and binaries and release this with minimal changes under their own name.
To prevent that from happening we have been forced to set some limitations to how you
can use our product.
For any "normal" developer that uses XSharp to develop applications for end users this
should present no problems.
The simplified version of the limitations means that :
· You can only redistribute the 'runtime' components that are listed in the documentation.
You can not redistribute our compiler. However when needed, you can ask your
customer to download our compiler from this website
· You (when you are a FOX subscriber) have access to the compiler source code and
may change and rebuild the compiler for internal use inside your company. However you
are not allowed to publish or redistribute the (changed) compiler to your customers

We are convinced that you will find our license agreements fair and easy to work with.
If you have any questions about the licenses, please contact us at info@xsharp.eu

Short summary of the

Component Name
license
The compiler binaries and XSharp Open Software This can be downloaded for
runtime binaries License Agreement 1.0 free from our website. All you
have to do is to create an
account on this website.
· You can download the
components from our
website

© 2015- 2019 XSharp BV

 X# Documentation 112

· You can use the

components for free both
for commercial and
personal use
· You can only deploy the
runtime components to
your customers
· OEM Licensing of the
compiler binaries is only
allowed when you have a
separate agreement with
XSharp BV
The source code to the Apache License version 2.0 Everybody can access this
runtime, visual studio public source code in our
integration and tools public repository on GitHub
· You can download the
source from our GitHub
project
· You can make adjustments
to the source code both for
internal use and also to
redistribute the changed
runtime binaries to your
customers
· If you have a contribution
that you want to see
included in a future version
of XSharp you can send us
a pull request on GitHub
· XSharp BV decides which
changes will be included in
the main branch and which
not.
The Roslyn part of the Apache License version 2.0 This license applies to the
Compiler Source code Roslyn code that we have
used and that you can also
find on GitHub
The Antlr part of the Antlr BSD License This license applies to the
Compiler Source code Antlr 4 source code that we
have used and that you can
find on GitHub
Our custom Compiler XSharp Compiler Source This license applies to our
Source code code License 1.0 custom source code for the
XSharp compiler.
Only registered members of
the FOX program can access
this source code in our
private repository on GitHub

© 2015- 2019 XSharp BV

 113 XSharp Bandol

· Subscribers may download

this code and make
changes for internal use
· If you have a contribution
that you want to see
included in the main source
you can send a pull request
on GitHub
· XSharp decides which
changes to the source
code will be included in the
main branch and which not
· If we accept your
contribution and consider it
a "substantial" change then
we can recognize you as a
Contributor
· Contributors are allowed to
distribute the program
under their own license

1.1.7.1 XSharp Open Software License

The X# Compiler binaries and runtime binaries are licensed under the XSharp Open
Software License Agreement. The full text of this license is:

XSHARP OPEN SOFTWARE LICENSE AGREEMENT

Version effective date: Sept 15, 2015

Preamble:

The use of the Software is unsupported and is for personal or

commercial use. Support is available from XSharp under a separate
agreement, see Part 3.c.
For redistribution of the Software, you will require an OEM license,
see part 4.b. For more information on support options or
redistribution (e.g. OEM Licensing) please contact XSharp.
This license establishes the terms under which the Software may be
used, copied, modified, distributed and/or redistributed. The intent
of this license is that XSharp maintains control over the
development and distribution of the Software, while allowing its use
it in a variety of ways. If the terms of this license do not permit
your proposed usage or if you require clarification regarding your
intended use of the Software, please contact info@xsharp.eu

XSharp BV. ("XSharp") is willing to license the software only upon

the condition that you accept all of the terms contained in this
software license agreement. Please read the terms carefully. By
clicking on "yes, accept" or by installing the software, you will
indicate your agreement with them. If you are entering into this
agreement on behalf of a company or other legal entity, your

© 2015- 2019 XSharp BV

 X# Documentation 114

acceptance represents that you have the authority to bind such

entity to these terms, in which case "you" or "your" shall refer to
your entity. If you do not agree with these terms, or if you do not
have the authority to bind your entity, then XSharp is unwilling to
license the software, and you should not install the software.

1. Parties.

The parties to this Agreement are you, the licensee ("You") and
XSharp. If You are not acting on behalf of yourself as an
individual, then "You" means your company or organization. A company
or organization shall in either case mean a single business entity,
and shall not include its affiliates or wholly owned subsidiaries.

2. The software.

The accompanying materials including, but not limited to, binary

executables, documentation, images, and scripts, which are
distributed by XSharp, and derivatives of that collection and/or
those files are referred to herein as the "Software".

3. License Grant for the Software.

a. You are granted worldwide, perpetual, paid up, royalty free,

non-exclusive rights to install and use the Software subject to the
terms and conditions contained herein.

b. You may: (i) copy the Software for archival purposes, (ii) copy
the Software for personal use purposes, (iii) use, copy, and
distribute the Software solely for your organization's internal use
and or business operation purposes including copying the Software to
other workstations inside Your organization. Any copy must contain
the original Software's proprietary notices in unaltered form.

c. No Other Software and Services. XSharp will not provide you

with any other software or services (including any support or
maintenance services) relating to the Software, except to the extent
that such software and services, if any, are required and provided
pursuant to an applicable maintenance and support agreement.

4. Restrictions.

a. XSharp encourages you to promote use of the Software. However,

this agreement does not grant permission to use the trade names,
trademarks, service marks, or product names of XSharp, except as
required for reasonable and customary use in describing the origin
of the Software. In particular, you cannot use any of these marks in
any way that might state or imply that XSharp endorses Your work, or
might state or imply that You created the Software covered by this
Agreement. Except as expressly provided herein, you may not:

i. modify or translate the Software;

© 2015- 2019 XSharp BV

115 XSharp Bandol

ii. reverse engineer, decompile, or disassemble the Software,

except to the extent this restriction is expressly prohibited by
applicable law;

iii. create derivative works based on the Software;

iv. merge the Software with another product;

v. copy the Software; or

vi. remove or obscure any proprietary rights notices or labels on

the Software.

b. You may not distribute the Software via OEM Distribution (as
defined below) without entering into a separate OEM Distribution
Agreement with XSharp. "OEM Distribution" means permitting others
outside Your organization to use the Software, distribution and/or
use of the Software as either a bundled add-on to, or embedded
component of, another application, with such application being made
available to its users as, but not limited to, an on-premises
application, a hosted application, a Software-as-a-Service offering
or a subscription service for which the distributor of the
application receives a license fee or any form of direct or indirect
compensation. Except as expressly provided herein, you may not:

i. permit others outside Your organization to use the Software,

ii. redistribute:
1. the Software as a whole whether as a wrapped application or
on a stand-alone basis, or
2. parts of the Software to create a language distribution, or
3. the XSharp components with Your Wrapped Application.

The exception to this rule are the components of the software that
are explicitly listed in the documentation as “redistributable
files”. These files are also copied by the installation process of
the Software into to a separate folder with the name “Redist” under
the Software’s installation folder.

c. You are excluded from the foregoing restrictions in paragraph

4b if You are using the Software for non-commercial purposes as
determined by XSharp at its sole discretion, or if You are using the
Software solely for Your organization’s internal use and or internal
business operation purposes on non-production servers (e.g.
development and or testing).

5. Ownership.

XSharp and its suppliers own the Software and all intellectual
property rights embodied therein, including copyrights and valuable
trade secrets embodied in the Software's design and coding
methodology. The Software is protected by the copyright laws from
The Netherlands and international treaty provisions. This Agreement

© 2015- 2019 XSharp BV

 X# Documentation 116

provides You only a limited use license, and no ownership of any

intellectual property.

6. Infringement Indemnification.

You shall defend or settle, at Your expense, any action brought

against XSharp based upon the claim that any modifications to the
Software or combination of the Software with products infringes or
violates any third party right; provided, however, that: (i) XSharp
shall notify Licensee promptly in writing of any such claim; (ii)
XSharp shall not enter into any settlement or compromise any such
claim without Your prior written consent; (iii) You shall have sole
control of any such action and settlement negotiations; and (iv)
XSharp shall provide You with commercially reasonable information
and assistance, at Your request and expense, necessary to settle or
defend such claim. You agree to pay all damages and costs finally
awarded against XSharp attributable to such claim.

7. Limited Warranty.

Neither XSharp nor any of its suppliers or resellers makes any

warranty of any kind, express or implied, and XSharp and its
suppliers specifically disclaim the implied warranties of title,
non-infringement, merchantability, fitness for a particular purpose,
system integration, and data accuracy. There is no warranty or
guarantee that the operation of the software will be uninterrupted,
error-free, or virus-free, or that the software will meet any
particular criteria of performance, quality, accuracy, purpose, or
need. You assume the entire risk of selection, installation, and use
of the software. This disclaimer of warranty constitutes an
essential part of this agreement. No use of the software is
authorized hereunder except under this disclaimer.

8. Local Law.

If implied warranties may not be disclaimed under applicable law,

then any implied warranties are limited in duration to the period
required by applicable law. Some jurisdictions do not allow
limitations on how long an implied warranty may last, so the above
limitations may not apply to You. This warranty gives you specific
rights, and You may have other rights which vary from jurisdiction
to jurisdiction.

9. Limitation of Liability.

Independent of the forgoing provisions, in no event and under no

legal theory, including without limitation, tort, contract, or
strict products liability, shall XSharp or any of its suppliers be
liable to you or any other person for any indirect, special,
incidental, or consequential damages of any kind, including without
limitation, damages for loss of goodwill, work stoppage, computer
malfunction, or any other kind of commercial damage, even if XSharp
has been advised of the possibility of such damages. This limitation

© 2015- 2019 XSharp BV

 117 XSharp Bandol

shall not apply to liability for death or personal injury to the

extent prohibited by applicable law. In no event shall XSharp's
liability for damages for any cause whatsoever, and regardless of
the form of action, exceed in the aggregate the amount of the
purchase price paid for the software license.

10. Export Controls.

You agree to comply with all export laws and restrictions and
regulations of The Netherlands, The European Union or foreign
agencies or authorities, and not to export or re-export the Software
or any direct product thereof in violation of any such restrictions,
laws or regulations, or without all necessary approvals. As
applicable, each party shall obtain and bear all expenses relating
to any necessary licenses and/or exemptions with respect to its own
export of the Software from The Netherlands or the European Union.

11. Severability.

If any provision of this Agreement is declared invalid or

unenforceable, such provision shall be deemed modified to the extent
necessary and possible to render it valid and enforceable. In any
event, the unenforceability or invalidity of any provision shall not
affect any other provision of this Agreement, and this Agreement
shall continue in full force and effect, and be construed and
enforced, as if such provision had not been included, or had been
modified as above provided, as the case may be.

12. Jurisdiction and Venue.

This Agreement is governed by the applicable laws of The

Netherlands.

13. Assignment.

Except as expressly provided herein neither this Agreement nor any

rights granted hereunder, nor the use of any of the Software may be
assigned, or otherwise transferred, in whole or in part, by
Licensee, without the prior written consent of XSharp. XSharp may
assign this Agreement in the event of a merger or sale of all or
substantially all of the stock of assets of XSharp without the
consent of Licensee. Any attempted assignment will be void and of no
effect unless permitted by the foregoing. This Agreement shall inure
to the benefit of the parties permitted successors and assigns.

1.1.7.2 Apache 2
Both the source code to the public elements of X# and to Roslyn are published under the
Apache 2.0 license.
You can find the public source code on Github in the XSharpPublic repository :
https://github.com/X-Sharp/XSharpPublic
The full text of this license is:

© 2015- 2019 XSharp BV

 X# Documentation 118

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by

the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity

exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical

transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or

Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object

form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including

the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of

© 2015- 2019 XSharp BV

119 XSharp Bandol

the copyright owner. For the purposes of this definition, "submitted"

means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity

on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of

this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of

this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the

Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or

Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

© 2015- 2019 XSharp BV

 X# Documentation 120

(d) If the Work includes a "NOTICE" text file as part of its

distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,

any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or

agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,

whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a

© 2015- 2019 XSharp BV

 121 XSharp Bandol

result of this License or out of the use or inability to use the

Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing

the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following

boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.

1.1.7.3 BSD
The Antlr source that we have used in our product is published under the BSD license.
The full text of this license is:

[The "BSD license"]

Copyright (c) 2015 Terence Parr, Sam Harwell
All rights reserved.

© 2015- 2019 XSharp BV

 X# Documentation 122

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote
products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

1.1.7.4 XSharp Compiler Sourcecode License

The source code to the XSharp compiler is available to registered FOX subscribers.
If you want access to this source code then please send an email to info@xsharp.eu.
We will then send you a personalized version of the license agreement below.
We will grant you access to the closed source code repository on Github
(https://github.com/X-Sharp/XSharpDev)
when we have received your signed version of this license agreement

XSHARP COMPILER SOURCE CODE LICENSE - V 1.0

Version effective date: Sept 15, 2015

The accompanying program is provided under the terms of this XSharp

compiler source code license ("agreement"). Any use, reproduction or
distribution of the program constitutes subscriber's acceptance of
this agreement.

1. DEFINITIONS

"Program" means the source code of the XSharp compiler

"Contribution" means:
a) in the case of the initial Contributor, the initial code and
documentation distributed under this Agreement, and
b) in the case of each subsequent Contributor:
i) changes to the Program, and

© 2015- 2019 XSharp BV

123 XSharp Bandol

ii) additions to the Program;

where such changes and/or additions to the Program originate from
and are distributed by that particular Contributor. A Contribution
'originates' from a Contributor if it was added to the Program by
such Contributor itself or anyone acting on such Contributor's
behalf. Contributions do not include additions to the Program which:
(i) are separate modules of software distributed in conjunction
with the Program under their own license agreement,
(ii) are not derivative works of the Program or
(iii) are not seen as substantial changes or additions by
XSharp BV.

"Licensed Patents" mean patent claims licensable by a Contributor

which are necessarily infringed by the use or sale of its
Contribution alone or when combined with the Program.

The "Friends Of XSharp" (FOX) community program is the subscription

service under which the XSharp project, represented by XSharp BV,
publishes the source code for the XSharp Compiler for its
subscribers.

"Binary Form" means a compiled version of the Program.

2. PARTIES

"XSharp BV" is "XSharp BV", a company from the Netherlands.

"Contributor" means any person or entity that contributes to the

Program and whose contribution is included by XSharp BV in the
official distribution of the Program.

"Subscriber" means anyone who subscribes to the FOX program and

receives the Program under this Agreement, including all
Contributors and including XSharp BV.

3. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby

grants Subscriber a non-exclusive, worldwide, royalty-free copyright
license to reproduce, prepare derivative works of, publicly display,
publicly perform, distribute and sublicense the Contribution of such
Contributor, if any, and such derivative works, in Binary Form.
Disclosure of the program other than in binary form to non-
Subscribers is explicitly forbidden.

b) Subject to the terms of this Agreement, each Contributor hereby

grants Subscriber a non-exclusive, worldwide, royalty-free patent
license under Licensed Patents to make, use, sell, offer to sell,
import and otherwise transfer the Contribution of such Contributor,
in Binary Form. This patent license shall apply to the combination
of the Contribution and the Program if, at the time the Contribution
is added by the Contributor, such addition of the Contribution
causes such combination to be covered by the Licensed Patents. The

© 2015- 2019 XSharp BV

 X# Documentation 124

patent license shall not apply to any other combinations which

include the Contribution. No hardware per se is licensed hereunder.

c) Subscriber understands that although each Contributor grants the

licenses to its Contributions set forth herein, no assurances are
provided by any Contributor that the Program does not infringe the
patent or other intellectual property rights of any other entity.
Each Contributor disclaims any liability to Subscriber for claims
brought by any other entity based on infringement of intellectual
property rights or otherwise. As a condition to exercising the
rights and licenses granted hereunder, each Subscriber hereby
assumes sole responsibility to secure any other intellectual
property rights needed, if any.

d) Each Contributor represents that to its knowledge it has

sufficient copyright rights in its Contribution, if any, to grant
the copyright license set forth in this Agreement.

4. RESTRICTIONS.

A Contributor may choose to distribute the Program in Binary Form

under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all
warranties and conditions, express and implied, including warranties
or conditions of title and non-infringement, and implied warranties
or conditions of merchantability and fitness for a particular
purpose;
ii) effectively excludes on behalf of all Contributors all
liability for damages, including direct, indirect, special,
incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this
Agreement are offered by that Contributor alone and not by any other
party; and
iv) states that source code for the Program is only available
for Subscribers.
Contributors may not remove or alter any copyright notices contained
within the Program.
Each Contributor must identify itself as the originator of its
Contribution, if any, in a manner that reasonably allows others to
identify the originator of the Contribution.
A complete list of all Contributors will be included with the source
code of the Program.

5. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain

responsibilities with respect to end users, business partners and
the like. While this license is intended to facilitate the
commercial use of the Program, the Contributor who includes the
Program in a commercial product offering should do so in a manner
which does not create potential liability for other Contributors.

© 2015- 2019 XSharp BV

125 XSharp Bandol

Therefore, if a Contributor includes the Program in a commercial

product offering, such Contributor ("Commercial Contributor") hereby
agrees to defend and indemnify every other Contributor ("Indemnified
Contributor") against any losses, damages and costs (collectively
"Losses") arising from claims, lawsuits and other legal actions
brought by a third party against the Indemnified Contributor to the
extent caused by the acts or omissions of such Commercial
Contributor in connection with its distribution of the Program in a
commercial product offering. The obligations in this section do not
apply to any claims or Losses relating to any actual or alleged
intellectual property infringement. In order to qualify, an
Indemnified Contributor must: a) promptly notify the Commercial
Contributor in writing of such claim, and b) allow the Commercial
Contributor to control, and cooperate with the Commercial
Contributor in, the defense and any related settlement negotiations.
The Indemnified Contributor may participate in any such claim at its
own expense.

For example, a Contributor might include the Program in a commercial

product offering, Product X. That Contributor is then a Commercial
Contributor. If that Commercial Contributor then makes performance
claims, or offers warranties related to Product X, those performance
claims and warranties are such Commercial Contributor's
responsibility alone. Under this section, the Commercial Contributor
would have to defend claims against the other Contributors related
to those performance claims and warranties, and if a court requires
any other Contributor to pay any damages as a result, the Commercial
Contributor must pay those damages.

6. LIMITED WARRANTY

Except as expressly set forth in this agreement, the program is

provided on an "as is" basis, without warranties or conditions of
any kind, either express or implied including, without limitation,
any warranties or conditions of title, non-infringement,
merchantability or fitness for a particular purpose. Each Subscriber
is solely responsible for determining the appropriateness of using
and distributing the Program and assumes all risks associated with
its exercise of rights under this Agreement, including but not
limited to the risks and costs of program errors, compliance with
applicable laws, damage to or loss of data, programs or equipment,
and unavailability or interruption of operations.

7. LIMITATION OF LIABILITY

Except as expressly set forth in this agreement, neither subscriber

nor any contributors shall have any liability for any direct,
indirect, incidental, special, exemplary, or consequential damages
(including without limitation lost profits), however caused and on
any theory of liability, whether in contract, strict liability, or
tort (including negligence or otherwise) arising in any way out of
the use or distribution of the program or the exercise of any rights
granted hereunder, even if advised of the possibility of such

© 2015- 2019 XSharp BV

 X# Documentation 126

damages.

8. SEVERABILITY.

If any provision of this Agreement is invalid or unenforceable under

applicable law, it shall not affect the validity or enforceability
of the remainder of the terms of this Agreement, and without further
action by the parties hereto, such provision shall be reformed to
the minimum extent necessary to make such provision valid and
enforceable.

9. PATENTS.

If Subscriber institutes patent litigation against any entity

(including a cross-claim or counterclaim in a lawsuit) alleging that
the Program itself (excluding combinations of the Program with other
software or hardware) infringes such Subscriber's patent(s), then
such Subscriber's rights granted under Section 2(b) shall terminate
as of the date such litigation is filed.
All Subscriber's rights under this Agreement shall terminate if it
fails to comply with any of the material terms or conditions of this
Agreement and does not cure such failure in a reasonable period of
time after becoming aware of such noncompliance. If all Subscriber's
rights under this Agreement terminate, Subscriber agrees to cease
use and distribution of the Program as soon as reasonably
practicable. However, Subscriber's obligations under this Agreement
and any licenses granted by Subscriber relating to the Program shall
continue and survive.

10. AGREEMENT STEWARD

Everyone is permitted to copy and distribute copies of this

Agreement, but in order to avoid inconsistency the Agreement is
copyrighted and may only be modified in the following manner. The
Agreement Steward reserves the right to publish new versions
(including revisions) of this Agreement from time to time. No one
other than the Agreement Steward has the right to modify this
Agreement. XSharp BV is the initial Agreement Steward. XSharp BV may
assign the responsibility to serve as the Agreement Steward to a
suitable separate entity. Each new version of the Agreement will be
given a distinguishing version number. The Program (including
Contributions) may always be distributed subject to the version of
the Agreement under which it was received. In addition, after a new
version of the Agreement is published, Contributor may elect to
distribute the Program (including its Contributions) under the new
version. Except as expressly stated in Sections 2(a) and 2(b) above,
Subscriber receives no rights or licenses to the intellectual
property of any Contributor under this Agreement, whether expressly,
by implication, estoppel or otherwise. All rights in the Program not
expressly granted under this Agreement are reserved.

11. JURISDICTION AND VENUE.

© 2015- 2019 XSharp BV

 127 XSharp Bandol

This Agreement is governed by the applicable laws of The

Netherlands. No party to this Agreement will bring a legal action
under this Agreement more than one year after the cause of action
arose. Each party waives its rights to a jury trial in any resulting
litigation.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the XSharp compiler source code license to

your work.

To apply the XSharp compiler source code License to your work,

attach the following boilerplate notice, with the fields enclosed by
brackets "[]" replaced with your own identifying information. (Don't
include the brackets!) The text should be enclosed in the
appropriate comment syntax for the file format. We also recommend
that a file or class name and description of purpose be included on
the same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the X# compiler source code License, Version 1.0

(the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.xsharp.info/licenses

Unless required by applicable law or agreed to in writing, software

Distributed under the License is distributed on an "as is" basis,
without warranties or conditions of any kind, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.

1.1.8 Acknowledgements
We could not have done this project without (source code) contributions from others.
Below is a list of the contributions that we used for our compiler and Visual Studio
integration

Name Description
Roslyn The X# compiler is based on the open
source project Roslyn, which contains the
source to the Microsoft VB and C#
compilers.
Our project would have been impossible
with this source.

© 2015- 2019 XSharp BV

 X# Documentation 128

We are very grateful that Microsoft has

moved this project to the open source.
(github.com/dotnet/roslyn)
The source code to Roslyn is published
under the Apache License, version 2
Antlr The X# compiler uses Antlr 4 as parser
generator to generate the front end of the
compiler. We would like to thank Terence
Parr and Sam Harwell for their excellent
work.
The source code to Antlr is published under
the BSD License. (www.antlr.org)
Wix (votive) The project system for Wix (Votive). We
have been inspired by some of the code in
this system. We would like to thank Rob
Mensching and the other authors of this
project system. (wixtoolset.org/)
Nemerle The project system for Nemerle. We have
been inspired by some of the solutions in
their project system. We would like to thank
the authors of Nemerle for showing us how
to solve certain problems.
(www.nemerle.org)
F# project system The visual F# project system
(www.fsharp.org/)
Help and Manual Our documentation is written with the
excellent tool "Help and Manual" from
Alexander Halser
(www.helpandmanual.com)
Sandcastle Help File Builder The documentation for the runtime is
generated with a special version of the
Sandcastle Help File Builder product.
(github.com/EWSoftware/SHFB)
Paul Piko For his Hybrid classes that allow to mix VO
GUI with Windows Forms

1.1.9 Who is who in the X# team

The founders of the X# project started the X# project in the summer of 2015.
They have ample experience with the xBase language. They all worked on the Visual
Objects and/or Vulcan.NET development teams, and some of them have created 3rd
party additions to Visual Objects and/or Vulcan.NET or created tools for VO and Vulcan
developers.

They are in alphabetical order:

© 2015- 2019 XSharp BV

 129 XSharp Bandol

Name Country Email Role in the X#

development team
Fabrice Foray France fabrice@xsharp.eu Visual Studio
integration,
examples, tutorials
Nikos Kokkalis Greece nikos@xsharp.eu (Macro) Compiler
Chris Pyrgas Greece chris@xsharp.eu Support, tools,
examples, tutorials,
runtime
Robert van der Hulst The Netherlands robert@xsharp.eu Management,
Compiler, Runtime,
Visual Studio
integration,
Documentation

If you are interested in participating in the development of X# please contact us and let us
know what your area of expertise is. There are plenty of things to do !

1.2 Migrating apps from VO to X#

In this topic we will discuss how to migrate applications from VO to X# with the aid of the
VO XPorter tool from X#.
When you want to do this we strongly recommend you to start small. We will therefore
start with a few VO example programs and describe the steps to take and the changes
that need to be made after the conversion.

Requirements
Since X# does not have a runtime yet you need to have the Vulcan Runtime to be able to
run your VO apps with minimal change in X#. You can use any Vulcan runtime, starting
with Vulcan 2. Even the runtime from the evaluation version of Vulcan is sufficient.

The examples
The examples on the following pages show you a step by step introduction to migrating
your apps.
For each example there will be an example supplied with the installer of X#. The examples
come with a "before" and "after" folder.

1.2.1 Example 1: The VO Explorer Example

Please note: This example assumes that you have installed X# with the default installation
options, and that the X# runtime is installed in the GAC.
If you have not done that then the example won't run. Please see the chapter about this in
this documentation

As first example of XPorting VO apps we take the VO Explorer example.

Start the VO Xporter program and point it to the VO Explorer example:

© 2015- 2019 XSharp BV

 X# Documentation 130

On my machine the VO installation is in the C:\Cavo28SP3 folder. That may be different

on your machine of course.
I have not changed any or the xPort options. The options are:
Option Description

RemoveClassClause Remove the “Class Clause” for methods and

accesses/assigns. This will group all methods
inside a CLASS .. END CLASS block and then
the CLASS clause at the method level is no
longer required
ChangeInitAxitToCtorDtor Init and Axit are reserved method names in VO.
In DotNet these names are often used by
classes. Vulcan and X# have introduced new
keywords CONSTRUCTOR and
DESTRUCTOR. This option automatically
renames the Init and Axit Methods. Example:

METHOD Init(oOwner) CLASS MyClass

becomes

CONSTRUCTOR(oOwner)

RemoveDeclareMethod If you used strong typing in VO you needed to

add DEC LARE METHOD statements and/or

© 2015- 2019 XSharp BV

131 XSharp Bandol

DECLARE ACCESS and DECLARE ASSIGN.

The X# compiler still recognizes these
statements but no longer requires them
AllClassesArePartial Partial classes is a mechanism in Vulcan and
X# that allows you to split a class over multiple
source files. That may be convenient if your
classes have become very big or if you want to
separate generated code from hand written
code (like what the Windows Forms Editor in
Visual Studio does). You can choose to make
all Xporter classes partial. We have disabled
this because there is a (small) performance
penalty when you use this. Especially if you
have split the Accesses and Assigns from your
class over separate files.
AddMissingConstructors VO allows you to declare a class without Init
method / Constructor. In .Net this is also
allowed., but then the compiler assumes you
have a class with a constructor without
parameters.
This compiler option will automatically generate
missing constructors.
IgnoreDuplicateDefines If you select this then duplicate defines will
simply be ignored and not written to the output
files.
Don’tGenerateEmptyFiles Each module from your VO application will
become a source file in X#. This option will
suppress the generation of empty source files
AdjustCallbackFunctions Some (advanced) VO code contains callback
functions where the address of a function is
passed to another function and will get called.
The Windows API uses that a lot, for example
for enumerating windows or printers. That
mechanism will not work in .Net. This option
will change your code and will help you to get a
working solution.
ExportOnlyDefines This option allows you to generate a DLL with
only the defines from the AEF(s) or files you
have selected. That may be useful if you have
ported your code before with the Vulcan
Transporter and want to get rid of the header
files with the defines.
Sort Entities by name This will sort all entities on name, Methods will
be sorted inside the CLASS.. ENDCLASS and
functions will be sorted as well
Use XSharp Runtime When you select this (the default) then your
app will be compiled against the X# runtime.

© 2015- 2019 XSharp BV

 X# Documentation 132

Otherwise we will use the Vulcan runtime

(which is not included with our product)
Copy Resources to Project folder When you select this option then all BMP, ICO,
CUR etc resources that are used in resource
entities in your app will be copied to a
Resources subfolder inside your project.
Replace Resource Defines with Value This controls the way that the numeric
identifiers associated with menu options and
control identifiers on forms are exported to the
external resource files

The XPorter will allow you to select a destination folder and names for your Visual Studio
solution and project files.
After pressing xPort you will see the following folder s
C:\XporterOutput\Examples\Explorer
C:\XporterOutput\Examples\Explorer\Explorer
C:\XporterOutput\Examples\Explorer\Explorer\Resources
C:\XporterOutput\Examples\Explorer\Explorer\Properties
The first folder is the so called “Solution” folder
The subfolder contains the project and its files.
If you had selected multiple AEF files then each AEF would have its own subfolder under
the Solution Folder
The solution folder contains the files:
File Contains

Explorer.sln VS Solution file

Explorer.viproj XIDE project file
SDK_Defines.dll Helper file that contains the defines from
the Vulcan VO SDK assemblies

The project folder contains the files

File Contains

Customer Explorer.prg Module source code

Data Servers.prg Module source code
Explorer Shell.prg Module source code
Explorer.viapp XIDE Application file
Explorer.xsproj VS Project file
Help About.HelpAboutDialog.rc Form resource used by VS
Help About.HelpAboutDialog.xsfrm Form "binary" used by VS
Help About.prg Module source code
Help About.rc Form resource used by XIDE

© 2015- 2019 XSharp BV

133 XSharp Bandol

Icons.ICONONE.rc Icon resource used by VS

Icons.ICONTWO.rc Icon resource used by VS
Icons.prg Module source code
Icons.rc Icon resources used by XIDE
Menus.CustomerExplorerMenu.rc Menu resource used by VS
Menus.CustomerExplorerMenu.xsmnu Menu "binary"
Menus.CustomerExplorerMenu_Accelerato Menu accelerators resource used by VS
r.rc
Menus.EMPTYSHELLMENU.rc Menu resource used by VS
Menus.EMPTYSHELLMENU.xsmnu Menu binary
Menus.EMPTYSHELLMENU_Accelerator.r Menu accelerator resource used by VS
c
Menus.OrdersListViewMenu.rc Menu resource used by VS
Menus.prg Module source code
Menus.rc Menu resources for XIDE
Start.prg Module source code

To compile and build the project we open the file Explorer.SLN in Visual Studio. Inside
Visual Studio it looks like:

The arrows in front of several modules show that there are subitems in these modules.
Those subitems contain the Form, Menu and Icon resources.
Now let’s try to build the solution inside Visual Studio. (Menu option Build – Build Solution)
This compiles the application and builds a debuggable version in the c:
\XporterOutput\Explorer\Debug folder. You will see that this folder contains an EXE, PDB
(debug symbols) and copies of the VO runtime libraries:
Explorer.exe
Explorer.pdb
SDK_Defines.dll
VOGUIClasses.dll
VORDDClasses.dll
VOSystemClasses.dll
VOWin32APILibrary.dll

© 2015- 2019 XSharp BV

 X# Documentation 134

XSharp.VO.dll
XSharp.RT.dll
XSharp.Core.dll
Now can try to run the app. This works, but as soon as we select the File/Open menu
option we will get a runtime error. After some resizing the screen looks similar to this

The error message is clear: the app uses the splitwindow control and this requires the
splitwindow support DLL.
This DLL is located in the Redist folder of your VO installation. Simply copy the
“Cato3spl.dll” file from your VO Redist folder to the output folder as well as the
MSVCRT.DLL and try again.
You can also add the DLLs to your project (Add Existing Item, and point to the DLLs in the
Redist folder). This will copy them to the project folder. Then set the build action for the 2
DLLs to None and the “Copy to Output Directory” property to “Preserve Newest”. When
you now build your app the DLL will be copied to the right folder.
After that the code will run just like it did in VO with no code changes!
Let’s have a closer look at what the xPorter has done:
· Each module in VO has become a PRG file in the X# project
· Source code has been grouped by class and put in a CLASS .. END CLASS construct
· Init methods have been renamed to CONSTRUCTOR
· Compiler macros such as "%CavoSamplesRootDir%\Explorer\" have been replaced
with literal values: "C:\cavo28SP3\Samples\Explorer\"
· Recourses have become “children” of the source file where they were defined
· Locations for resources have also been changed %CavoSamplesRootDir%
\Explorer\TWO.ICO has been changed to ICONTWO Icon C:
\cavo28SP3\Samples\Explorer\TWO.ICO.
Also the RESOURCE keyword has been removed.
· The binaries for the forms and menus have not been included in this version of the
XPorter (Beta 11). That will change.
· The Start file has the biggest change. In VO there was a method in there App:Start().
However the App class is not defined in this application but part of the GUI Classes.
There was also no Start function in the App. VO would call the Start function in the GUI
classes and would merge the App:Start() method in the application with the rest of the
App class in the GUI Classes.
This is not allowed in .Net. Classes cannot be spread over more than one assembly
(the .Net name for of a Library, EXE or DLL).
Therefore the XPorter has created a new class (xApp) and moved the Start method to

© 2015- 2019 XSharp BV

135 XSharp Bandol

this Xapp class. It has also added a Start() function which instantiates the App class and
calls the Start method inside XApp. You can also see in the example below that a TRY ..
CATCH .. END TRY construct is added which captures the errors that are not catched
anywhere else and shows an error message in an ErrorBox object. This is the errorbox
that was shown before because the CATO3SPL.DLL was missing.
· Finally the Start function is marked with an attribute (The word between the square
brackets). In this case the attribute is [STAThread] which means that the main function
(and therefore the whole app) needs to run in Single Threaded Appartment mode. This
is important if your app uses external code such as OCX/ActiveX controls.

-
· If you look closer to the solution explorer in Visual Studio and click on the References
node in the tree you will see that the example has references to the Vulcan runtime and
the VO Class libraries as well as the SDK defines library that was included with the
XPorter.
· If you open the project properties you will see on the General page that the selected
dialect is “Visual Object” , on the Dialect page are most VO options are set and on the
Build page the platform target is x86 (because the GUI classes are designed to run in
x86 mode) and several warnings have been suppressed. These warnings are:
Number Meaning
162 Suppresses a warning about Unreachable
code
618 Suppresses a warning about the use of
obsolete functions, such as CollectForced
649 Suppresses a warning about unused
private and/or internal fields.
9025 Suppresses a warning about missing
return statements
9032 Suppresses a warning about return values
inside ASSIGN methods and/or
constructors/destructors
9043 Suppresses a warning about ambiguous
code, which could happen if two
assemblies define a function with the same
name.
In this particular example only warning 618 is generated by the compiler because the
CustomerExplorer:Close() method calls CollectForced. After commenting out that line you
can remove all the “suppressed” warnings from the app and it will compile without any
warnings.
You will find the "code before" and "code after" in the XSharp Examples folder

© 2015- 2019 XSharp BV

 X# Documentation 136

1.2.2 Example 2: The VOPAD Example

This example converts the VOPAD AEF file from the C:
\cavo28SP3\Samples\Controls\Richedit folder.
After converting it with the same options as the 1st example we will have a folder structure
like
C:\XporterOutput\Examples\VoPad
C:\XporterOutput\Examples\VoPad\VoPad

File Contains

VoPad.sln VS Solution file

VoPad.viproj XIDE project file
SDK_Defines.dll Helper file that contains the defines from
the Vulcan VO SDK assemblies

The project folder contains the files

File Contains

!Readme!.prg Module source code

image.IMAGE.rc Image resource for VS
image.prg Module source code
image.rc Image resource for XIDE
Manifest.CREATEPROCESS_MANIFEST_ Manifest resource for VS
RESOURCE_ID.rc
Manifest.prg Module source code
Manifest.rc Manifest resource for XIDE
PadHelp About.HelpAbout.rc Help about resource for VS
PadHelp About.HELPABOUT.xsfrm Help about form Binary for VS
PadHelp About.POWVOBMP.rc Splash resource for VS
PadHelp About.prg Module source code
PadHelp About.rc Help resources for XIDE
PadMenus.StandardPadMenu.rc Menu resource for VS
PadMenus.StandardPadMenu.xsmnu Menu binary for VS
PadMenus.StandardPadMenu_Accelerator. Accelerator resource for VS
rc
PadMenus.prg Module source code
PadMenus.rc Resources for XIDE

© 2015- 2019 XSharp BV

137 XSharp Bandol

PadShell.IDI_VOPADICON.rc App Icon resource for VS

PadShell.prg Module source code
PadShell.rc App Icon resource for XIDE
PadStart.prg Module source code
PadWin.oMarginDialog.rc Form resource for VS
PadWin.oMarginDialog.xsfrm Form binary for VS
PadWin.prg Module source code
PadWin.rc Form resource for XIDE
Vopad.viapp XIDE Application
Vopad.xsproj VS Project

Open the project in VS and compile. You will see the following errors / warnings

PadWin.prg(473,1): warning XS1030: #warning: 'The following method did not include
a CLASS declaration'
PadWin.prg(480,1): warning XS1030: #warning: 'The following method did not include
a CLASS declaration'
PadHelp About.prg(78,3): error XS9046: Cannot assign to 'font' because it is a
'method'
PadHelp About.prg(81,8): error XS0119: 'TextControl.Font(params __Usual[])' is a
method, which is not valid in the given context
PadHelp About.prg(88,3): error XS9046: Cannot assign to 'font' because it is a
'method'
PadHelp About.prg(91,8): error XS0119: 'TextControl.Font(params __Usual[])' is a
method, which is not valid in the given context
PadWin.prg(166,19): error XS1061: 'RichEdit' does not contain a definition for
'RTFChangeFont' and no extension method 'RTFChangeFont' accepting a first argument
of type 'RichEdit' could be found (are you missing a using directive or an assembly
reference?)

Let's examine this by double clickig on the errors / warnings:

First the warnings. These are generated by a #warning preprocessor statement inserted
by XPorter because it found problems in your code:
· There was an ACCESS FilterIndex CLASS SaveAsDialog in the source. This adds an
access to a class in the GUI Classes. This is not allowed in .Net.
The XPorter has created a special subclass of SaveAsDialog to hold this extra property.
Fortunately this ACCESS is no longer needed because it has been added to the GUI
Classes already.
So we can completely de lete that code.
· There was a method RTFChangeFont CLASS RichEdit. The same problem as the
SaveAsDialog:FilterIndex. In this case the method is necessary. It has been moved to a
subclass of RichEdit already. However since the original code still points to the RichEdit
class there could be a runtime problem because this method is not part of the richedit
class.
There are 2 possible solutions here:
1. Change the method to an extension method
2. Change the code that uses the RichEdit class to use the changed class
Option 1 is the best here since we are not using any private or protected properties of
the RichEdit class here. To achieve that change the code from

© 2015- 2019 XSharp BV

 X# Documentation 138

CLASS RichEdit_external_class INHERIT RichEdit

METHOD RTFChangeFont()
etc

to

STATIC CLASS RichEditExtensions

STATIC METHOD RTFChangeFont( SELF oEdit as RichEdit) AS VOID
LOCAL oFontDlg AS StandardFontDialog
oFontDlg := StandardFontDialog{oEdit:Owner}
oFontDlg:FontColor := oEdit:TextColor
oFontDlg:Font := oEdit:ControlFont
oFontDlg:Show()
oEdit:TextColor := oFontDlg:FontColor
oEdit:ControlFont := oFontDlg:Font
END CLASS

Note
The Extension Method works great to enhance existing classes, but has one
disadvantage: The Vulcan Runtime will not pick up these extension methods for late
bound code.That is not a problem in this example but may be a problem elsewhere.

Now we have added an extension method that can be used like a normal method.
This change also solves the error in PadWin.prg
Then look at the other problems: they all have to do with a Font property in the TextControl
class. Unfortunately the VO class libraries have both a Font() method and a Font()
Access/Assign for the TextControl class. Having a method and a property with the same
name is not allowed in .Net.
When the VO Gui classes were ported to Vulcan the decision has been made to rename
the Font property to Controlfont. So we need to make that change. Simply double click on
the errors and change

:Font

to

:ControlFont

(4 times)
After that the code should compile and run. Clicking the Font button on the toolbar should
show the font dialog (from the RTFChangeFont extension method)
Some of the changes that were made to the code (omitting the ones that were also in
example 1):
· Manifest.prg is empty but included because it had a dependent resource.

You will find the "code before" and "code after" in the XSharp Examples folder

© 2015- 2019 XSharp BV

 139 XSharp Bandol

1.2.3 Example 3: The Pizza Example

Our 3rd migration example is the Pizza Example. You can find this in the
Samples\Controls\Buttons folder in your VO Installation.
I have selected the same output folder (C:\XporterOutput\Examples\) and the XPorter will
create a Pizza subfolder with the contents of the AEF and a Pizza solution in the
Examples folder.
There is no real need to list the files again. You get the idea.
After opening Pizza.sln inside visual Studio and compiling you will find the following
problems:

The problem is:

· The original VO program had an output name 'PIZZA.EXE'.
· The X# compiler uses the same logic as the Vulcan compiler and creates a static class
called Pizza.Exe.Functions that will hold the functions in the application, the globals and
(new for X#) the defines.
· The application also has an image called 'PIZZA'.
· When we compile this app there is now a conflict between the class named PIZZA and
the namespace Pizza (from the class Pizza.Exe.Functions).
· This is something that is not recommended by the DotNet standard. Vulcan ignores this
and allows both a class Pizza and a namespace Pizza. X# follows the .Net guidelines
more closely.
· There are 2 solutions to this problem:
o Rename the image class Pizza (inside Images.prg)
o Rename the output filename. To rename the output filename open the Project Settings
(from the Project menu) and set the Assembly Name on the "General" page. You
could rename the assembly to PizzaApp and it will solve the problem
· In this case I choose to rename the PIZZA image. So open Images.PRG and rename

CLASS PIZZA INHERIT Bitmap

to

CLASS ImgPIZZA INHERIT Bitmap

· Then recompile again. Now one problem is left:

C:\XporterOutput\Examples\Pizza\Order Dialog.prg(165,25): error XS0246: The type
or namespace name 'PIZZA' could not be found (are you missing a using directive
or an assembly reference?)

· This is the place where the Pizza image is used in the example app. To change this,
open the Order Dialog window (Order Dialog.ORDERDIALOG.xsfrm). Select the button
on the bottom left and change the "Image" text in the property window from Pizza to
ImgPizza. Save the form. The code will be regenerated as well.
· If you look at the order dialog rc file after the changes you will see that the file has been
marked with a header that this code was generated. Also #defines have been added for
all windows styles used in the form. The resource is "self contained" so there is no
dependency on any external file in the resource file.

© 2015- 2019 XSharp BV

 X# Documentation 140

· Recompile and the program compiles.

· When we run the program we see that it works as expected:

You will find the "code before" and "code after" in the XSharp Examples folder

1.2.4 Example 4: Ole Automation - Excel

For the 4th example we will not use a standard example from Visual Objects but will
create a new sample app in Visual Objects to remote control Excel and to write data to an
Excel Sheet.
I found the following example in the Comp.Lang.Clipper.Visual-Objects newsgroup (which
I changed a little bit for this example).
· Create a new terminal application in Visual Objects and copy and paste the code below
into the app.
· Open the application Properties and add the Ole Library.
· Also rename the app to "ExcelTest".
· Now open the start module and copy the code.
· Compile and run, and you will find an xls file in the C:\ExcelTest folder.

FUNCTION Start()
LOCAL oExcel AS OBJECT

© 2015- 2019 XSharp BV

141 XSharp Bandol

LOCAL oWorkBooks AS OBJECT

LOCAL oWorksheet AS OBJECT
LOCAL oRange AS OBJECT
LOCAL cFile AS STRING
cFile := "C:\ExcelTest\example.xls"
DirMake("C:\ExcelTest")
oExcel:=OLEAutoObject{"Excel.Application"}
oExcel:Visible:=FALSE // Don't show the EXCEL execute
oExcel:DisplayAlerts:=FALSE // Don't show messages
oWorkBooks:=oExcel:Workbooks
oWorkBooks:add() //open a new worksheet
oWorkSheet:=oExcel:ActiveSheet // active the first sheet
oRange:=oWorkSheet:[Range,"A1","A1"] // A1 cell
oRange:SELECT()
oRange:FormulaR1C1:="Hello my text"
oExcel:ActiveWorkBook:SaveAs(cFile,56,"","",;
FALSE,FALSE) //"56" save the file in work book of EXCEL 97-2003
(Excel 8)

oWorkBooks:Close()
oExcel:Quit()
WAIT

RETURN NIL

· Export the AEF to "C:\ExcelTest\ExcelTest.AEF"

· Run the VOExporter and export the code.
· After opening the solution inside Visual Studio you will also get an application with one
source file (Start.prg). The source is almost identical with one difference. The line :

oRange:=oWorkSheet:[Range,"A1","A1"] // A1 cell

has been changed to

oRange:=oWorkSheet:Range["A1","A1"] // A1 cell

· Note that the name Range is now in front of the Square brackets.
Range is a so called "Indexed property" of the worksheet. Visual Objects uses a "funny"
syntax for this.
X# uses the same syntax that most other languages do. The property looks like an array
(the square brackets) .
· Now compile the app in X#. You will get the following errors:

© 2015- 2019 XSharp BV

 X# Documentation 142

Let's look at these errors:

· The last errors in the list indicate that the Start method is not correct. This is because
the Start function in .Net has to either be a VOID function or a function that returns an
INT. In this case no return type has been declared, so X# thinks you want to create a
function that returns a USUAL. Change the prototype of the start function to:

FUNCTION Start() AS VOID

and remove the NIL return value from the RETURN statement.

· Now 2 errors remain. These indicate that X# does not know how to convert the array
index from string to int. This is on the line with the range assignment.
The code above uses 'Late Binding', so the types are not known at compile time. X#
does not know if the Range property from the Worksheet object is an indexed property
or if it returns an array. It assumes that it returns an array and wants to specify the array
index which is numeric (and subtract one because Visual Objects uses 1 based arrays
where .Net uses 0 based arrays).
· The best way to fix this is to use strong typing and use the Generated Class wrappers
for Excel.
In Visual Objects you would use the 'Automation Server' tool to generate such a class
wrapper. In .Net there is a similar tool. The easiest way to achieve this is to add a
reference to Excel to the references of the application:
· Right Click on "References" in the solution Explorer and Choose "Add Reference"
· In the 'Add Reference' dialog, choose the COM tabpage
· Locate the "Microsoft Excel nn.m Object Library". On my machine that is Excel 16.0.

· Click Ok.
· This will add an entry to your References list with the name
"Microsoft.Office.Interop.Excel". This is a generated type library that contains class
definitions for all types inside Excel.

© 2015- 2019 XSharp BV

143 XSharp Bandol

· Now go into your code, add a Using statement for the namespace of the Excel classes
and change "AS OBJECT" to the right types:

USING Microsoft.Office.Interop.Excel
FUNCTION Start() AS VOID
LOCAL oExcel AS Application
LOCAL oWorkBooks AS Workbooks
LOCAL oWorksheet AS Worksheet
LOCAL oRange AS Range

· Also change the call to create the Main Excel object:

oExcel:=ApplicationClass{}

· Your code is now strongly typed, so you should also get intellisense if you try to select a
member from one of these objects, such as oExcel:Workbooks.
· Compile and run the code . It works as expected.
· You may want to change the value 56 in the SaveAs line to the appropriate enum value:
xlFileFormat.xlExcel8
· Now run the app again and everything works as expected.
· If you look in the folder where the EXE is generated you will see both ExcelTest.Exe and
Microsoft.Office.Interop.Excel.dll, the type library

Note 1
If you are wondering why we declare oExcel as Application but use ApplicationClass to
instantiate the object, here is the reason:
Application is the interface, ApplicationClass is the actual class that implements the
Application interface. This is a model that you will see for most Automation Servers.

Note 2
Many people have asked for a way to implement OLE Events. With the X# code and the
generated type library this is very easy.
Add the following code to the start method to define a BeforeSave and AfterSave event

oExcel:WorkbookBeforeSave += OnBeforeSave
oExcel:WorkbookAfterSave += OnAfterSave

and add the following functions

FUNCTION OnBeforeSave (oWb AS Workbook, SaveAsUI AS LOGIC, Cancel REF Logic)

AS VOID
? "OnBeforeSave", oWb:Path, oWb:Name, SaveAsUI
RETURN

FUNCTION OnAfterSave (oWb AS Workbook, Success AS LOGIC) AS VOID

? "OnAfterSave", oWb:Path, oWb:Name, Success
RETURN

And run the example again. You will see that both functions are called. Before the save the
path and name are not set properly, afterwards they are set to the values specified in the

© 2015- 2019 XSharp BV

 X# Documentation 144

code
Some versions of Excel do not support the WorkbookAfterSave event. In that case
you will get a compile time error

Note: If you run this code through the debugger and set a break point in the
OnBeforeSaveAs you will see that the callstack in these events is a
little bit weird:
there is no Start() function inside this callstack ( I have disabled the
'Just My code option', otherwise you would only see the line with
OnBeforeSave())

That is because these events are called on a separate thread. If you look at the
Threads window in VS (Debug - Windows - Threads) you will see that:

Note 3
If you look closely in the Add References dialog you may also find other occurrences of
the Excel library (on the .Net tab). On my machine these are:

These are so called "Primary Interop Assemblies" (PIAs), pre-compiled assemblies, for
different Excel versions. You can use these as well. These assemblies are installed with
the Office Developers Tools for Visual Studio. On my machine they are located in
subfolders of "c:\Program Files (x86)\Microsoft Visual Studio 14.0\Visual Studio Tools for
Office\PIA" .

You will find the "code before" and "code after" in the XSharp Examples folder

© 2015- 2019 XSharp BV

 145 XSharp Bandol

1.2.5 Example 5: OCX - The Email Client Example

This example shows how to migrate an application that uses an ActiveX/OCX Control.
We are using the Email example from Visual Objects that you can find in the Examples
folder, subfolder Email.
The problem that we can expect here is that the Vulcan Runtime does not support ActiveX
controls.
So lets try to solve this.
· First run VOXporter and create a Visual Studio solution from the AEF
· Compile and run in Visual Studio.
· We will get 2 messages:

The first message shows the biggest problem in this example. The second message was
inserted by the Xporter to warn us that the original code was adding a method to a class
that exists inside the VO Gui classes.
Lets fix these problems quickly to be able to compile the app. We will add the OCX Later:
· Click on the warning. You will see that the XPorter has added a CLASS
ToolBar_external_class that inherits from Toolbar. The original code was trying to add
the ShowButtonmenu method to the existing Toolbar class.
· We can solve this problem, that we have also seen in the VOPAD example by either
adding an Extension Method or by subclassing the Toolbar class.
· Just like in the VOPAD example I prefer the extension method.
· Change the class name and method declaration. We will create 2 overloads, because
the symTb parameter is optional:

STATIC CLASS ToolBarExtensions

STATIC METHOD ShowButtonMenu(SELF tbSelf as Toolbar, nButtonID as LONG,
oButtonMenu as Menu) AS VOID
tbSelf:ShowButtonMenu(nButtonID, oButtonMenu, #MAINTOOLBAR)
RETURN
STATIC METHOD ShowButtonMenu(SELF tbSelf as Toolbar, nButtonID as LONG,
oButtonMenu as Menu,symTb as Symbol) AS VOID

· Remove the Default() line and replace SELF in the body of the original ShowButtonMenu
with tbSelf
· We will also have to make some changes to the code that calls this method. This is due
to the fact that the code calls ShowButtonMenu on the Toolbar access from the window
class. This Toolbar access is untyped and therefore returns a USUAL..
So locate the 2 lines with SELF:ToolBar:ShowButtonMenu and change that to ((Toolbar)
SELF:ToolBar):ShowButtonMenu. You cannot use the oToolbar field of the Window
class, because the DataWindow class will return the Toolbar from its framewindow in
stead of its own toolbar.
In the improved VO SDK that we will include with our X# runtime we will solve this
problem by strongly typing properties such as Window:Toolbar.
Maybe you would be tempted to add the Extension methods to the USUAL type, so you
would not have to add the casts to the code that calls ShowButtonMenu.

© 2015- 2019 XSharp BV

 X# Documentation 146

That will compile, but unfortunately will produce a problem at runtime. The X# compiler
(like the Vulcan and VO Compilers) knows that the USUAL type is special and will not try
to emit a method call, but will produce code that calls Send() on the usual to call its
method. And the Vulcan Runtime does not handle extension methods inside the Send()
function.
· We can confirm that this works later when we press the "Reply" button on the toolbar.
That should bring up the menu with "Reply to Sender" and "Reply to All"
Now it is time to fix the ActiveX/OCX problem
· Click on the error about OleControl.
· As a quick workaround we will change the code and let webbrowser inherit from
MultiLineEdit. That gives us a control that will certainly work. We will implement the OCX
later. To do so go to the Class Webbrowser.PRG and change the INHERIT clause. It
says INHERIT OleControl now. Change that to INHERIT MultiLineEdit.
· Compile again and now some other errors will be shown. 2 of these mention the type
cOleMethod. Goto this code by double clicking the error.
· You will see the Quit method of the Webbrowser class. This code uses an internal
class and internal methods from the VO OLE Classes. Comment out the contents of
this method for now.
· Compile again and you will see that only a few errors are left. Some of these are the
same as the error in the VOPAD Example and require that we change the Font property
to ControlFont. Correct that.
· One error points to an incorrect '+' operator: in the line

cTemp += +"; "+ cEntry

· This is an obvious error in the original VO code that was never picked up by the VO
Compiler. Remove the + before the double quote
· The last error comes from the constructor of the Webbrowser class. It is calling the
CreateEmbedding method from the OleControl. This method does not exist in the
MultiLineEdit class, so we comment it out for now. We will deal with the Webbrowser
later.
· The rest of the code should compile without problems after commenting out the call to
SELF:CreateEmbedding().
· You should be able to run the app now.
· There will be a runtime error if you try to open the Address Book because it uses the
Databrowser control which depends on Cato3Cnt.dll. Fix this by copying the cato3*.dll
and msvcrt.dll from the Cavo28\Redist folder to your output folder.
· Recompile and run the example. I twill now produce an error inside the Display method
of the Webbrowser class (DisplayHtml if you have used the Email example from VO 2.8
SP4).
This method takes the content of the email, writes it to disk and calls the Navigate
method of the Webbrowser control (late bound, using the Send() function of VO). This
will not work.
Since we have changed the webbrowser control and made it a multi line edit we can
change this behavior. Instead of writing the email text to disk we can simply assign it to
the TextValue property of the MultiLineEdit. So comment out the body of the Display
method (do not throw the code away we will need it later) and replace it with:

SELF:TextValue := cText

© 2015- 2019 XSharp BV

147 XSharp Bandol

· After that the sample should run without problems. You can also display the emails. Of
course it will not show HTML properly but that is the next step.

How to add the ActiveX to the code

The VO compatible GUI classes inside Vulcan do not support ActiveX Controls. Windows
Forms however has great support for ActiveX Controls.
We will use the ActiveX support from Windows Forms to add the ActiveX control to the
example.
There are 2 possibilities here:
1. Replace the whole Email Display window with a Windows Forms window
2. Use a trick to use Windows Forms to show the ActiveX control and merge that control
into our VO GUI app
The first solution is by far the easiest to understand, but we will have to create a whole
new window and we will have to change the calling code as well.
We leave it up to you to make the choice for your own apps.
In this example we will the choose the second approach.

Create a Windows Forms Window to display the email

For this method we use a Windows.Forms.Form window as "Host" for the ActiveX control.
We will instantiate that window and will grab the windows handle to the control and link
that windows handle with our VO GUI window.
To do this you must take the following steps:
· Right Click on the project icon in the solution explorer and select "Add New Item"
· This brings up a list of possible new items. Choose the icon for Windows Forms Form,
give it a meaningful name, such as "EmailDisplayForm.prg" and click Add.
· This will open the Form Designer window.
· Open the ToolBox. The webbrowser control will not be in there.
· Right click on an empty area in the toolbox and select "Choose Items...". This will bring
up a dialog where you can control the contents of the ToolBox.
· Select the "COM Components" Tab and scroll down until you see the Microsoft Web
Browser control:

· Tick the checkbox in front of the control and press Ok. This should add the ActiveX to
the toolbox:

· You can drag the control to a different place in the Toolbox if you are not happy with
where it landed.
· Now drag the Control from the ToolBox to the form. There is no need to size or move
the control.
· Visual Studio will add two references to our project. These are:
o AxSHDocVw, a type library that contains that code for the actual ActiveX control
o SHDocVw, a type library that contains code for the supporting automation server
interfaces and classes

© 2015- 2019 XSharp BV

 X# Documentation 148

· The form editor will add a field named axWebBrowser1 to the form. This field is of the
type AxSHDocVw.AxWebBrowser.
· Goto the property window and change the Modifiers Field to change it from Private to
it Public (Export).
That will make the field accessible outside of the webBrowserHost class
· Save the code, and close the form
· Now goto the Webbrowser class
· Add the following using clauses to the top of the file:

using Email
using AxShDocVw
using ShDocVw

The first using is the namespace where the webBrowserHost window is generated. The
second namespace is the namespace of the generated ActiveX and the third namespace
if that of the other types that we need, such as enums and events.
· Add the following 2 fields (no need to elaborate I think):

EXPORT oHost as webBrowserHost

EXPORT oWebBrowser as AxWebBrowser

· Goto the constructor of the Webbrowser class and add the following lines of code (in
stead of the CreateEmbedding() that we commented out before)

SELF:oHost := webBrowserHost{} // Create the host window, do not

show !
SELF:oWebBrowser := SELF:oHost:axWebBrowser1 // Get the ActiveX on the
form
SetParent(oWebBrowser:Handle, self:Handle()) // Using Windows API "steal"
its handle and link to the MLE
SELF:oWebBrowser:Visible := TRUE // make the webbrowser visible
SELF:Okay := TRUE

· And add the following methods to make sure that the ActiveX has the same with and
height as the MultiLineEdit that is its owner and to make sure it is properly destroyed,

METHOD Resize(oEvent)
LOCAL oDim as Dimension
SUPER:Resize(oEvent)
oDim := SELF:Size
IF oDim:Width > 0
SELF:oWebBrowser:SuspendLayout()
SELF:oWebBrowser:Location := System.Drawing.Point{0,0}
SELF:oWebBrowser:Size := System.Drawing.Size{oDim:Width,oDim:Height}
SELF:oWebBrowser:ResumeLayout()
ENDIF
RETURN NIL

METHOD Destroy()

© 2015- 2019 XSharp BV

149 XSharp Bandol

SUPER:Destroy()
SELF:oWebBrowser:Dispose()
SELF:oHost:Dispose()
RETURN NIL

· And we need to "restore" the old behavior to display the HTML in the browser window,
that we commented out before.
So goto the WebBrowser:Display() method (DisplayHtml for VO 2.8 SP4) and restore
the old code and change

Send(SELF, #Navigate, cFileName)

into

SELF:oWebBrowser:Navigate(cFileName)

so you change this into an early bound method call

· To finish our work, browse through the source of the webbrowser class and find lines
that call Navigate, such as

Send( SELF, #Navigate, "#top" )

and change these to early bound method calls:

SELF:oWebBrowser:Navigate("#top" )

And look for lines like:

Send( SELF, #ExecWB, OLECMDID_PRINT, OLECMDEXECOPT_DODEFAULT, NIL, NIL )

and change these to early bound method calls using enums in the type library. Also
remove the NIL values:

SELF:oWebBrowser:ExecWB(OLECMDID.OLECMDID_PRINT,
OLECMDEXECOPT.OLECMDEXECOPT_DODEFAULT )

· That wraps it up. Everything works now, including the PrintPreview and Print
functionality.
· Of course you can now also use the activeX events and respond to them.
You have to do that the .Net way. Something like this:

SELF:oWebBrowser:NavigateComplete2 += NavigateComplete2

and then the implementation

© 2015- 2019 XSharp BV

 X# Documentation 150

METHOD NavigateComplete2(sender AS OBJECT, e AS

DWebBrowserEvents2_NavigateComplete2Event) AS VOID
SELF:Owner:StatusBar:SetText("Showing file:" +e:uRL:ToString())

You will find the "code before" and "code after" in the XSharp Examples folder

1.3 The X# Runtime

In X# version 2 - Bandol we have introduced the X# runtime.

In this chapter we would like to give you an overview of the design decisions that we
made, what the runtime looks like, where you can find which types and functions etc.
We will also list here the features that are not supported yet.

Introduction
When we designed the X# compile and X# Runtime we had a few focus points in mind:
· The language and runtime should be VO compatible whenever
possible. We know that the Vulcan devteam made some decisions not
to support certain features from VO, but we decided that we would like
to be as compatible as technically possible.
· We want our runtime to be fully Unicode and AnyCPU. It should run on
any platform and also both in x86 and x64 mode. That has caused
some challenges because VO is Ansi (and not Unicode) and also X86.
In VO you can cast a LONG to a PTR. That will not work in X64 mode
because a LONG is 32 bits and a PTR 64 bits
· We want the code to compile in "Safe" mode. No unsafe code when
not strictly needed. The biggest problem / challenge here is the PTR
type. With a PTR you can access memory directly and read/write from
memory, even if you don't "own" that memory. However the same PTR
type is also used as "unique identifier" for example in the low level file
i/o and in the GUI classes for Window and Control handles. These
PTR values are never used to read/write memory but are like object
references. We have decided to use the .Net IntPtr type for this kind of
handles. Of course the compiler can transparently convert between
PTR and IntPtr.
· We want to prove that the X# language is a first class .Net
development language. That is why we decided to write the X# runtime
in X#. By doing that we also create a large codebase to test the
compiler. So that is a win - win situation.
· We want the runtime to be thread safe. Each thread has its own
"global" state and its own list of open workareas. When a new thread
is started it will inherit the state of the main thread but will not inherit
the workareas from the main thread
· At this moment the X# Runtime is compiled against .Net Framework
4.6.

© 2015- 2019 XSharp BV

151 XSharp Bandol

Assemblies in the X# Runtime

If you want to know in which Assembly a function or type is defined then your "best friend"
is the documentation. We are using a tool to generate the documentation, so this is
always correct.
Some subsystems have functions XSharp.Core DLL and in XSharp.VO.DLL as well.

Component Description Language / Framewo

dialect used rk
Version
XSharp.Core.D This is the base DLL of the X# Runtime. X# Core 4.6
LL
XSharp.RT.DLL This DLL is required for all dialects X# non - core 4.6
apart from Core
XSharp.VO.DLL This DLL adds features to the runtime X# VO and X# 4.6
that are needed for the VO and Vulcan Vulcan
dialects.
XSharp.XPP.DL This DLL adds features to the runtime X# XPP 4.6
L that are needed for the Xbase++ dialect.
XSharp.VFP.DL This DLL adds features to the runtime X# FoxPro 4.6
L that are needed for the FoxPro dialect.
XSharp.Macroc This DLL is the X# "fast" macro X# Core 4.6
ompiler.DLL compiler.
XSharp.MacroC This DLL is the X# "full" macro X# Core 4.6
ompiler.Full.DL compiler.
L
XSharp.RDD.D This will contain the various RDDs X# Core 4.6
LL implemented for X#.
VO SDK Class These DLLs represent the class X# VO and X# 4.6
libraries: libraries from Visual Objects Vulcan
VOConsoleClas
ses.dll
VOGUIClasses.
dll
VOInternetClas
ses.dll
VORDDClasse
s.dll
VOReportClass
es.dll
VOSQLClasses
.dll
VOSystemClas
ses.dll

© 2015- 2019 XSharp BV

 X# Documentation 152

Component Description Language / Framewo

dialect used rk
Version
VOWin32APILib
rary.dll

Known Issues
· The macro compiler in this release is fully functional but not as fast as we'd like. We are
working on a smaller and faster macro compiler.
· The DBFCDX RDD is missing

Missing or incomplete Features

Feature Description Expected when

RDD system The DBFCDX RDD is Jan-Feb 2019
missing
MemVar support There are already some Jan 2019
statements in the language
(like MEMVAR, PRIVATE
etc) but the underlying
runtime support and
compiler support is not
ready
Some runtime functions are These functions will most
not supported yet: likely be added in one of the
Crypt functions (Crypt(), next betas. For now they will
CryptA()) throw a
Encoding functions notimplementedexception
(B64Enc.., UUEnc.., when you use them
GetChunkBase64 etc)

Fast Macro compiler We are not happy with the

speed of the current macro
compiler. It is very powerful
but compiling a macro
simply takes too much time.
We are working on a
replacement for this. To
help increase performance
we are caching compiled
macros at this moment, so
the second time you
compile the same macro
you will get the same
codeblock back as the first
time. That helps but is not
enough.

© 2015- 2019 XSharp BV

153 XSharp Bandol

Description of Various Subsystems

Subsystem Remarks
Low Level File IO These functions are implemented in XSharp.Core.
There is an important difference between the implementation
in XSharp.Core when compared to VO.
In VO the file handles returned from functions such as
FCreate() and FOpen() are OS file handles. That means that
you can also pass them directly to Win32 API Functions. In
the X# Runtime that is no longer possible.
We use .Net FileStream objects for the File IO. The File
handler returned (which is of the IntPtr type) is a unique key
into a table where we are storing these File IO objects. The
keys are generated from random numbering. You can't and
shouldn't rely on the values of these keys.
Static Memory IO The static memory subsystem allocates memory using the
Marshal.AllocHGlobal functionality. Each memory block has 2
guard blocks that contain information about the group number,
size and a magic number. We have also implemented
memory groups.
Unlike in VO you cannot release all blocks in a group by
simply closing the Memory Group.
If you want to enumerate allocated blocks you should first call
MemTrace(TRUE) to enable block tracing.
Then create a function with the following prototype

FUNCTION MyMemWalker(pMem AS IntPtr, nSize AS DWORD) AS

LOGIC
Then call MemWalk and pass your function as parameter.
The runtime will call your function and will pass in all memory
blocks that have been allocated and not released yet.

Late Binding Support The Runtime fully supports late binding. The late binding
support still needs some optimizations.
We recommend to only use this when necessary. New code
should either use the DYNAMIC type or try to use early bound
code as much as possible.

Combining the X# Runtime and Vulcan Runtime

Technically it is possible to include both the X# and the Vulcan runtime libraries in your
application. When you do so then the compiler will assume that you want to use the X#
implementations for the XBase types such as USUAL and DATE. If the compiler does not
find the XSharp.Core and XSharp.VO assemblies then it will assume you want to map
these types to the Vulcan runtime types.
So you can mix things. However if you want to call code in the Vulcan runtime DLLs you
may have to use the fully qualified classnames or typenames.
And remember: there is no automatic translation between the X# types and Vulcan types.

© 2015- 2019 XSharp BV

 X# Documentation 154

If you want to convert an X# variable to a Vulcan variable you may have to cast it to an
intermediate type first.

Call Vulcans implementation of Left()

LOCAL cValue as STRING

cValue := VulcanRTFuncs.Functions.Left("abcdefg",2)

If you want to convert an X# usual to a Vulcan usual, cast to OBJECT

LOCAL xUsual as USUAL

LOCAL vUsual as Vulcan.__Usual
xUsual := 10
vUsual := (OBJECT) xUsual

For dates you can do something similar. In that case you should cast the X# date to a
DateTime.

LOCAL xDate as DATE

LOCAL vDate as Vulcan.__VODate
xDate := ToDay() // will call the X# implementation of
ToDay()
vDate := (System.DateTime) xDate

1.3.1 XSharp.Core
This is the base DLL of the X# Runtime. It contains:
• Common interfaces, such as IDate, IFloat, ICodeBlock,
IMacroCompiler, used by other X# components
• Runtime functions that use standard .Net datatypes such as SLen(),
AllTrim(), SLen().
· The Runtime State (SetDeleted(), SetExact() etc)
· The Workarea information
· The nation resources and collations.
• RDD related functions that do not depend on XBase types as DATE,
USUAL and FLOAT.
· The low level File/IO

This assembly can be used in all dialects of X#

1.3.2 XSharp.RT
This DLL adds the following features to the runtime:
· XBase specific types , such as DATE, ARRAY, USUAL, PSZ,
SYMBOL etc
· CodeBlock type (base class for compile time codeblocks)
· _CodeBlock type (base class for macro compiled codeblocks)
· Runtime functions that accept parameters of these types.
· Memory related functions (MemAlloc, MemFree etc)

© 2015- 2019 XSharp BV

 155 XSharp Bandol

· Terminal IO functions (QOut(), Accept, Wait).

· RDD Related functions that have optional parameters or parameters
of XBase Type
· Functions to compile and evaluate macros (MComp, MExec)
· Late binding functions such as Send(), IVarGet() etc
· VObject type
· OLEAutoObject type

This assembly should be linked in when you compile for anything other than the Core
dialect

1.3.3 XSharp.VO
This DLL adds some specific types and functions that are unique to the VO and Vulcan
dialect. Functions such as
QueryRtRegInt()
QueryRtRegString()
MB..()

Also many obsolete functions from VO are in this DLL.

This DLL also contains the classes

ErrorDialog
NameArg
OleAutoObject
OleAutoObjectFromFile
OleDateTime
VObject

1.3.4 XSharp.XPP
This DLL adds some specific types and functions that are unique to the Xbase++ dialect
and also many of the Xbase++ defines.
Functions such as
ClassCreate
ClassDestroy()
ClassObject()
XMLDocOpenFile()
XMLDocSetAction()
etc.

Also some Xbase++ specific types such as

Abstract
ClassObject

1.3.5 XSharp.VFP
This DLL adds some specific types and functions that are unique to the FoxPro dialect

Functions such as
CreateObject()
etc.

© 2015- 2019 XSharp BV

 X# Documentation 156

1.3.6 XSharp.Macrocompiler
This DLL is the X# "fast" macro compiler. The Macro compiler is written in C# and has a
hardcoded dependency on XSharp.Core.

Please note that there is no link between XSharp.RT.DLL and

XSharp.Macrocompiler.DLL. When you compile a macro then the runtime will try to locate
the macro compiler with the method listed below.
You can override this mechanism by calling SetMacroCompiler() with the type of the class
that implements the macro compiler. This type should implement the
XSharp.IMacroCompiler interface. If you want to use the standard macro compiler then
you need to add a reference to XSharp.MacroCompiler.dll and add the following code to
the startup code of your application:

SetMacroCompiler(typeof(XSharp.Runtime.MacroCompiler))

If you don't do this then the runtime will try to locate the macro compiler in the following
locations:
· The directory where the XSharp.RT.DLL is loaded from
· The directories in the path. If you use this then make sure that the
assemblies listed below are in the same folder as
XSharp.MacroCompiler.DLL
· The Global Assembly Cache (GAC). If you use this mechanism then
make sure that the assemblies listed below are also in the GAC.

This assembly depends on:

· XSharp.Core.DLL

Note
The XSharp installer adds the Macro compiler and the assemblies it depends on to the
GAC so you will be able to run your apps without adding the macro compiler to the
references list of your application. Please make sure you include the macro compiler in
your installer when deploying your applications.

1.3.7 XSharp.Macrocompiler.Full.DLL
This DLL is the X# "full" macro compiler. The Macro compiler is created as a class
wrapper on top of the X# scripting engine

We are working on a smaller and faster macro compiler. More news about that will follow.

Please note that there is no link between XSharp.VO.DLL and

XSharp.Macrocompiler.DLL. When you compile a macro then the runtime will try to locate
the macro compiler with the method listed below.
You can override this mechanism by calling SetMacroCompiler() with the type of the class
that implements the macro compiler. This type should implement the
XSharp.IMacroCompiler interface. If you want to use the full macro compiler in stead of the
standard (fast) macro compiler then you need to add a reference to

© 2015- 2019 XSharp BV

 157 XSharp Bandol

XSharp.MacroCompiler.Full.dll and add the following code to the startup code of your
application:

SetMacroCompiler(typeof(XSharp.MacroCompiler))

If you don't do this then the runtime will try to locate the standard macro compiler in the
following locations:
· The directory where the XSharp.R.DLL is loaded from
· The directories in the path. If you use this then make sure that the
assemblies listed below are in the same folder as
XSharp.MacroCompiler.DLL
· The Global Assembly Cache (GAC). If you use this mechanism then
make sure that the assemblies listed below are also in the GAC.

This assembly depends on:

· XSharp.Scripting.DLL
· XSharp.CodeAnalysis.DLL
· System.Collections.Immutable
· System.Reflection.Metadata

Note
The XSharp installer adds the Macro compiler and the assemblies it depends on to the
GAC so you will be able to run your apps without adding the macro compiler to the
references list of your application. Please make sure you include the macro compiler in
your installer when deploying your applications.

1.3.8 XSharp.RDD
This DLL contains the various RDDs that come with X#:
· DBFNTX (including DBT memos)
· DBFCDX (Including FPT memos)

You can also uses "limited" RDDs with do not have all the functionality:
· CAVODBF or DBF: Just DBF Files
· DBFDBT: DBF files with DBT memos, no index support
· DBFFPT: DBF files with FPT memos, no index support

The Advantage RDDs (require advantage DLLs)

· ADSADT
· AXDBFCDX
· AXDBFNTX
· AXDBFVFP

· Advantage.ADSADT
· Advantage.AXSQLCDX
· Advantage.AXSQLNTX
· Advantage.AXSQLVFP

In one of the coming releases we will add support for:

© 2015- 2019 XSharp BV

 X# Documentation 158

· DBFVFP = DBFCDX with support for additional Visual FoxPro datatypes.

· DBFMEMO = DBF + NTX + DBV
· DBFBLOB = DBF without associated DBF file
· DELIM
· SDF

and may be, if there is enough interest:

DBFNSX = DBF + SMT + NSX

1.3.9 Installation in the GAC

The default behavior of the X# installer is to register the X# runtime in the GAC. The
following files are registered there

· XSharp.Core.DLL
· XSharp.RT.DLL
· XSharp.VO.DLL
· XSharp.XPP.DLL
· XSharp.VFP.DLL
· XSharp.RDD.DLL
· XSharp.Macrocompiler.DLL
· VOConsoleClasses.dll
· VOGUIClasses.dll
· VOInternetClasses.dll
· VORDDClasses.dll
· VOReportClasses.dll
· VOSQLClasses.dll
· VOSystemClasses.dll
· VOWin32APILibrary.dll

Some components are dynamically loaded at runtime and do not have to added as
references to your application:
· XSharp.RDD.DLL
· XSharp.Macrocompiler.DLL

The X# runtime tries to locate these assemblies in the GAC and in the directory where the
application is installed.
If you are not installing the runtime to the GAC, then you must make sure that these two
DLLs are available in your application folder. Otherwise you will get a runtime error when
these DLLs are needed.

1.3.10 XBase Types

The table below shows the type mapping between XBase types in X#.
All types in the namespace XSharp are implemented in XSharp.VO.DLL and are only supported when
NOT compiling in the Core dialect

© 2015- 2019 XSharp BV

 159 XSharp Bandol

XBase Type Implemented in type

ARRAY XSharp.__Array
ARRAY OF <t> XSharp.__ArrayBase <T>
BYTE System.Byte
CHAR System.Char
CODEBLOCK XSharp.CodeBlock
_CODEBLOCK XSharp._CodeBlock
DATE XSharp.__VODate
DATETIME System.DateTime
DECIMAL System.Decimal
DWORD System.UInt32
DYNAMIC System.Dynamic
FLOAT XSharp.__VOFloat
INT / LONG / LONGINT System.Int32
INT64 System.Int64
LOGIC System.Boolean or XSharp.__WinBool
OBJECT System.Object
PSZ XSharp.__Psz
PTR System.IntPtr
REAL4 System.Float
REAL8 System.Double
SHORT / SHORTINT System.Int16
STRING System.String
SYMBOL XSharp.__Symbol
UINT64 System.UInt64
USUAL XSharp.__Usual
VOID System.Void
WORD System.UInt16

1.3.10.1 Array Of Type

This type is used for typed arrays. It has been introduced in the X# Runtime. The internal
typename is XSharp.__ArrayBase
The code below shows how you can use it.
Many of the existing XBase runtime functions that accept arrays now also accept an
ARRAY OF.

© 2015- 2019 XSharp BV

 X# Documentation 160

Runtime functions that expect a codeblock for Arrays expect a Lambda expression for
ARRAY OF.
The difference is that the parameters to the Lambda expression will be typed, so there is
no late binding necessary.
Parameters to a Codeblock are always of type usual and therefore either require Late
Binding support or need to be casted to the right type inside the codeblock.
We have also introduced a special multi dimensional syntax. Given the example below
you can also get the first name of the first developer in the array by using the following
syntax:

cFirst := aDevelopers[1, "FirstName"]

This may be useful when you work with existing generated code and the existing code
was using a define for the elements in the multi dimensional array.
If you had a (generated) define like

DEFINE DEVELOPER_FirstName := 1

then you can change the code generator and generate this in stead

DEFINE DEVELOPER_FirstName := "FirstName"

The code that uses the define can remain unchanged

cFirst := aDevelopers[1, DEVELOPER_FirstName]

Example code

FUNCTION Start AS VOID

// declare typed array of developer objects
LOCAL aDevelopers AS ARRAY OF Developer
// Initialize the array with the "normal" array syntax
aDevelopers := {}
// AAdd also supports typed arrays
AAdd(aDevelopers, Developer { "Chris","Pyrgas"})
AAdd(aDevelopers, Developer { "Nikos", "Kokkalis"})
AAdd(aDevelopers, Developer { "Fabrice", "Foray"})
AAdd(aDevelopers, Developer { "Robert", "van der Hulst"})
// AEval knows that each element is a developer
AEval(aDevelopers, { d => Console.WriteLine(d)})
// ASort knows the type and passes the correct types to the lambda
expression.
// The compiler and runtime "know" that x and y are Developer objects and
will produce early bound code
ASort( aDevelopers, 1, ALen(aDevelopers), { x, y => x:LastName <
y:LastName})
// Foreach knows that each element is a Developer object
FOREACH VAR oDeveloper IN aDevelopers

© 2015- 2019 XSharp BV

 161 XSharp Bandol

? oDeveloper:LastName, oDeveloper:FirstName
NEXT
RETURN

CLASS Developer
PROPERTY FirstName AS STRING AUTO
PROPERTY LastName AS STRING AUTO
CONSTRUCTOR()
RETURN
CONSTRUCTOR (cFirst AS STRING, cLast AS STRING)
FirstName := cFirst
LastName := cLast
METHOD ToString() AS STRING
RETURN Firstname+" " + LastName
END CLASS

1.3.10.2 Array Type

This implements the so called "ragged" arrays.
The internal typename is XSharp.__Array

1.3.10.3 CodeBlock
This is the parent class for compile time codeblocks.
There is also a subclass _CodeBlock which is the parent class for macro compiled
(runtime) codeblocks
The internal type names are XSharp.CodeBlock and XSharp._CodeBlock

1.3.10.4 Date Type

This structure holds year, month, day in 32 bits. For date calculations it uses the
System.DateTime calculation logic. There are implicit converters between Date and
DateTime.
The internal type name for this type is XSharp.__Date

1.3.10.5 Float Type

This structure is a combination of a REAL8 (System.Double) and a width and # of
decimals.
It is not a reference type like in VO.
The internal type name for this type is XSharp.__Float

1.3.10.6 Logic Ttype

For normal use the logic type is mapped to System.Boolean.
Inside VOSTRUCT and UNION the XSharp.__WinBool is used because this is a 4 byte
value just like the Win32 api expects.

© 2015- 2019 XSharp BV

 X# Documentation 162

1.3.10.7 PSZ Type

This structure contains a pointer to a memory block with an Ansi string. When created
with String2Psz() and Cast2Psz() then the compiler will take care of releasing these
memory blocks. When created with other runtime functions such as StringAlloc() then you
are responsible of releasing the memory yourself.
The internal type name for this type is XSharp.__Psz

Note
Please do not use the PSZ type for new code. It is only included for backward
compatibility.
Even new code that calls the windows API can use a better alternative, for example using
the [DllImportAttribute] from the framework

1.3.10.8 Symbol Type

This structure holds just a number. This number is a reference to a string table that
contains the actual string representation of the symbol.
The internal type name for this type is XSharp.__Symbol

1.3.10.9 Usual Type

The USUAL type in X# is implemented as a .Net structure. It contains a type flag and a
value. The value can be one of the following types:
NIL, Long, Date, Float, Array, Object, String, Logic, Codeblock, Symbol, Ptr, Int64,
DateTime, Decimal, DateTime
The internal type name for this type is XSharp.__Usual

Type Usual Type Number

NIL 0
Long 1
Date 2
Float 3
Array 5
Object 6
String 7
Logic 8
Codeblock 9
Symbol 10
Ptr 18
Int64 22
DateTime 26
Decimal 27

© 2015- 2019 XSharp BV

 163 XSharp Bandol

Note that some Usual Type numbers are not included in this table. There are defines in
the compiler for these numbers, but they are never stored inside a USUAL.
So you can write UsualType(uValue) == REAL8 but that will NEVER be true.

You can assign values of these other types to a USUAL but the values will be converted to
a type listed in the first table. For example if you assign a DWORD to a USUAL then the
runtime will look at the value of the DWORD and if it is smaller or equal to MAX_LONG
then it will store the value as a LONG. Otherwise it will store it as a FLOAT. Please note
that although we support the Int64 type the DWORD conversion does not use this to be
compatible with VO. Also if you assign a PSZ to a USUAL then it will be stored as a
STRING. So the runtime will automatically call Psz2String() to get the string
representation.

Name Usual Type Number

Byte 11
Short 12
Word 13
DWord 14
Real4 15
Real8 16
PSZ 17
Usual By Ref 19
UInt64 23
Char 24
Dynamic 25

1.4 X# Scripting
Below is the text from the presentation from the session that Nikos did in Cologne during
the XBase.Future 2017 conference.
The examples from this session are stored during the installation of X# in the folder c:
\Users\Public\Documents\XSharp\Scripting

Why endorse scripting?

· Dynamic behavior at runtime

o Extensibility and flexibility
o User-defined behavior
· Platform independence
o System operations defined in a script
· Behavior as data
o Stored in files, database, cloud

© 2015- 2019 XSharp BV

 X# Documentation 164

o Updated at runtime
· Rapid prototyping

Scripting is...
· Expression evaluation
o Built-in interpreter
o Self-contained functionality
o Simple expressions or full statements
· Source file(s) without a project
o Single file (multiple sources may be loaded by a single script)
o No need for a full IDE or SDK
o Dynamic compilation without an IDE
o Definition of complex structures, classes

X# as a scripting language
· Roslyn script engine
o C# scripting
· Standalone expressions
o No START function
o Global statements, expressions
o Similar to the macro compiler (but not the same!)
o Host object maintains state

X# as a scripting language
· Complex declarations allowed
o Types, functions can be declared
o No namespaces!
· External references
o Loading assemblies
o No implicit access to host assembly
o No isolation (e.g. separate AppDomain)

The X-Sharp interpreter (xsi.exe)

· Read-Eval-Print Loop (REPL)
· Console application
· Return values are printed to the console
o With pretty formatting!
· Maintain context
· Declare LOCAL variables

The X-Sharp interpreter (xsi.exe)

· Can load assemblies, script files
o .PRGX extension
o #R directive
o #LOAD directive
· Can runs scripts from command line
o Xsi.exe <script.prgx>

© 2015- 2019 XSharp BV

165 XSharp Bandol

· Passes command-line arguments to scripts

o Xsi.exe <script.prgx> <arg> ...

Alternative ways to run scripts

· Setting xsi.exe as default app for .prgx
o Also creates file association, but without args
o Edit file association in registry
· Manually setting file association
o assoc, ftype
· Invoking without the .prgx extension
o PATHEXT
· Run without console?
o Not possible with xsi.exe since it is a console application

Scripting internals: the submission

· Every script is compiled into a “submission”
o Roslyn terminology
· Every line given to the xsi prompt creates a new submission
o Inherits previous submission
o Previously declared variables remain visible
· Cannot be inspected directly
o “SELF” and “SUPER” are not accessible

Scripting internals: the global object

· Statements execute in the context of the global object
· Generated by xsi.exe
o InteractiveScriptGlobals class
· Provides access to command-line arguments
· Print function with pretty-formatting options

Scripting internals: script declarations

· Are LOCALs declared in a script really local?
o Not when they are declared outside of a method
o They become fields of the submission class
· What about FUNCTIONs and PROCEDUREs?
o They become methods of the submission class
· Declared types? (CLASSes, STRUCTUREs, ENUMs)
o They become nested types in the submission class
o Not possible to have extension methods!

Application scripting: the first steps

· Add scripting capabilities to your application!
· Reference the script hosting and code analysis assemblies
o XSharp.CodeAnalysis.dll
o XSharp.Scripting.dll
· Important namespaces

© 2015- 2019 XSharp BV

 X# Documentation 166

o LanguageService.CodeAnalysis.Scripting
o LanguageService.CodeAnalysis.Xsharp.Scripting
· Run a script
o XSharpScript.RunAsync("? 'HELLO'")
o CompilationErrorException is thrown if the source has errors

Problem: how to pass arguments to a script?

· Passing arguments: the globals object
· The script can access public members of the globals object
o The type of the globals object can be custom
· An instance of the globals object can be passed to RunAsync()
o Public fields of the globals object can be used to pass arguments to the script
o The script will access them as variables
Problem: how to provide an API to the script?

Script API: the globals object

· Public members of the globals object are accessible by the script
o Remember: the script is compiled and executed in a different assembly in-memory!
· Not an elegant method to give access to types
o But excellent for a function-based API
o Self-contained, not prone to errors
· The script does not have direct access to all application types
· Not a security measure!
o The script is run in the same AppDomain (in a dynamic assembly)

Script API: using a common assembly

· Scripts can reference assemblies
o Through the #R directive
o Through the options passed to the RunAsync() call
· Move functions and types that should be accessible by the script to a separate
assembly
o The assembly can then be referenced by the script
· Can be used in conjunction with the globals object
Problem: how to get results back from a script?

Script result: return value

· Scripts can return a value with a RETURN statement
o ...or from a standalone expression!
o EvalAsync() returns that value
o RunAsync() returns a ScriptState object, from which the return value can also be
fetched

Script result: examine script state

· Variables declared by the script can be examined
o The ScriptState object returned by RunAsync() includes methods to examine the
variables

© 2015- 2019 XSharp BV

167 XSharp Bandol

· ScriptState.GetVariable(string name)

Advanced topics: handling errors

· Compilation errors
o CompilationErrorException thrown
o Roslyn API provides access to compilation messages
o Create script object with XsharpScript.Create()
o Compile with script:Compile()
· Returns list of diagnostic messages
· Runtime errors
o Exception is thrown
· AggregateException because script is ran as a Task
· e:InnerException property contains the real exception

Advanced topics: strong-typed return value

· By default a script returns OBJECT
· Custom return type can be specified
o Create<T>()
o RunAsync<T>()
o EvaluateAsync<T>()

Advanced topics: performance tuning

· Pre-compile scripts
o Script:Compile()
o Compiled scripts can be ran multiple times
o Similar to macros
· Delegate can be created with script:CreateDelegate()
· Native image with ngen.exe
o Speed-up initial compilation
o 64-bit version of ngen must be used for 64-bit CLR!!!
o Useful for command-line scripts (xsi.exe)

Advanced topics: functional scripts

· A script cannot be used exactly like a function
o Does not accept arguments
· Instead, it needs a global object instance
o Is run via a script hosting object
· Additional overhead
· But scripts can evaluate to functions!
o Lamda functions or delegates as return type

Advanced topics: accessing application

· Provide a reference to current assembly inmemory
o Assembly.GetExecutingAssembly()
o Does not work with CoreCLR
· Entities declared in current assembly can be used

© 2015- 2019 XSharp BV

 X# Documentation 168

o Functions & procedures

o Types (classes, structures, etc.)
o Namespaces

Advanced topics: support for dynamics

· Need to reference the proper assembly
o Microsoft.Csharp.dll

1.5 Using X# in Visual Studio

XSharp comes with 2 options for development environments:
1. Chris Pyrgas has adjusted his existing IDE to support XSharp (it is now called XIDE,
and compiled in XSharp !)
2. We supply Visual Studio integration for Visual Studio 2015. If you do not have Visual
Studio 2015, you can download a (free!) community edition from Visual Studio from
the web:
https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
The Visual Studio integration is also work in progress. What is supported in this version is:
· Edit
· Compile
· Debug
· Source control
· Windows Forms Editor
· WPF Editor
· Resource editor
· Settings editor

Known issues:
· Some of the intellisense features are not supported yet.
· There are no editors for VO Binary entities yet
· No support yet for .Net Core, .Net Standard, Portable class libraries and shared projects

1.5.1 Project System

1.5.1.1 Source code Items
1.5.1.2 Forms
1.5.1.3 Other Item types
1.5.1.4 Project Properties
1.5.1.5 Resources
1.5.1.6 Settings
1.5.2 Source Code Editor

© 2015- 2019 XSharp BV

 169 XSharp Bandol

1.5.2.1 Keyword Coloring

1.5.2.2 Highlighting Errors
1.5.2.3 Regions
1.5.2.4 Blocks
1.5.2.5 Parameter Tips
1.5.2.6 Quick Info
1.5.2.7 Code Completion
1.5.3 Templates
The Visual Studio integrations comes with a couple of predefined templates.
There are templates for:
· Projects
· Items

1.5.3.1 Project Templates

The X# Visual Studio integration comes with the following project templates:

Template Descriptio Required Default Reference

n Framewor Dialect s
k
version
ClassLibrar A project 2.0 Core System,
y for creating and some
a X# class extensions
library (.dll) for
frameworks
> 3.5
Console A project 2.0 Core System,
Application for creating and some
a extensions
command- for
line frameworks
application, > 3.5
using the
console
interface
Windows A project 2.0 Core System,
Forms for creating and some
Application an extensions
application for
with a frameworks
Windows > 3.5
Forms user System.Dra
interface. wing
System.Wi
ndows.For
ms

© 2015- 2019 XSharp BV

 X# Documentation 170

WPF Windows 3.0 Core System,

Application Presentatio and some
n extensions
Foundation for
client frameworks
application. > 3.5
WindowsB
ase,
Presentatio
nCore,
Presentatio
nFramewor
k
Vulcan A project 2.0 Vulcan System,
Application for creating and some
a Vulcan extensions
command- for
line frameworks
application. > 3.5
VulcanRT
and
VulcanRTF
uncs
Ms Test A Library 2.0 Core System and
Library with test several
support MsTest
using the related
MsTest assemblies
Framework
NUnitTest A library 2.0 Core System and
Library with test several
support NUnit
using the related
open assemblies
source .
NUnit The
Framework template
uses a
NuGet
package to
retrieve the
correct
assemblies
XUnitTest A library 2.0 Core System and
Library with test several
support XUnit
using the related
open assemblies
source .
The

© 2015- 2019 XSharp BV

 171 XSharp Bandol

XUnit template
Framework uses a
NuGet
package to
retrieve the
correct
assemblies

1.5.3.2 Item Templates

The X# Visual Studio integration comes with the following item templates:

Template Description Required

Framework
version
Category: Code
Class An empty class 2.0
definition

CodeFile An empty Code 2.0

File

Header An empty Header n/a

File

TextFile An empty text file n/a

Category: Forms
Windows Forms A Windows form 2.0
Form with separate
designer.prg

Windows Forms A simple Windows 2.0

Simple Form Forms Form
without
designer.prg
Windows Forms Windows Forms 2.0
User Control User Control

Category:
Resources

© 2015- 2019 XSharp BV

 X# Documentation 172

Native Resource A file in which n/a

File (.rc) native resources
can be defined

Bitmap A Bitmap file n/a

Cursor A Cursor file n/a

Icon An Icon file n/a

Managed resource A file to store 2.0

file (.resx) managed
resources

Category: WCF
WCF Service A WCF Service 3.0

Category: WPF
WPF Flow Dynamically 3.0
Document formatted XAML
document

WPF Page Windows 3.0

Presentation
Foundation page

WPF Page Windows 3.0

Function Presentation
Foundation page
function
WPF Resource XAML Resource 3.0
Dictionary Dictionary

WPF UserControl Windows 3.0

Presentation
Foundation user
control

© 2015- 2019 XSharp BV

 173 XSharp Bandol

WPF Window Windows 3.0

Presentation
Foundation
window

1.5.4 Debugger

1.6 X# Programming guide

1.6.1 Quick Start
1.6.2 Arrays
1.6.3 Classes and Structures
1.6.4 Codeblock, Lambda and Anonymous Method Expressions
X# contains 3 language constructs that are fairly similar yet different.

Codeblocks
Historically the XBase language has known the CodeBlock Type. A codeblock is specified
as

{| params | expression }

The parameters inside a codeblock are of type USUAL and its return value is also of type
USUAL.
To evaluate a codeblock you call the Eval() runtime function and pass this function the
codeblock and parameters when needed

FUNCTION Start() AS VOID

LOCAL cb as CODEBLOCK
cb := { |x, y| x * y}
? Eval(cb, 2,3) // shows 6
WAIT
RETURN

In stead of a single expression, you can also use an expression list. The value of the last
expression in the list is returned as the result of the codeblock.

FUNCTION Start() AS VOID

LOCAL cb as CodeBlock
cb := { |x, y| x += 1, x * y}
? Eval(cb, 2,3) // shows 9
WAIT
RETURN

© 2015- 2019 XSharp BV

 X# Documentation 174

Vulcan has also added the possibility to the language to include a list of statements as
"body" of the codeblock. The result of the last statement is returned to the calling code.
When the last statement is "Void" then a NIL will be returned:
Note that the closing Curly must be on a line of its own and the first statement must
appear on a new line as well.

FUNCTION Start() AS VOID

LOCAL cb as CodeBlock
cb := { |x, y|
x += 1
? x
RETURN x * y
}
? Eval(cb, 2,3) // prints 3 and shows the result 9
WAIT
RETURN

Lambda Expressions
Lamda expressions look a lot like Codeblocks. They are usually used in combination with
Delegates.

DELEGATE MultiPlyInt( x as Int, y as Int) as Int

FUNCTION Start() AS VOID

LOCAL lambda as MultiPlyInt
lambda := { x, y => x * y}
? Lambda(2,3) // shows 6
RETURN

Parameters are optional and the return type can be VOID, so this works as well

DELEGATE DoSomething( ) as VOID

FUNCTION Start() AS VOID

LOCAL lambda as DoSomething
lambda := { => Console.WriteLine("This is a Lambda")}
Lambda() // prints the text
RETURN

The parameters of a Lambda expression may be typed. This can be convenient for
documentation purposes but can also help the compiler to find the right overload for a
method:

© 2015- 2019 XSharp BV

 175 XSharp Bandol

DELEGATE CalcInt( x AS INT, y AS INT) AS INT

DELEGATE CalcReal( x AS REAL8, y AS REAL8) AS REAL8

FUNCTION Start() AS VOID

TestLambda( { x AS INT, y AS INT => x * y} )
TestLambda( { x AS REAL8, y AS REAL8 => x + y} )
TestLambda( { x , y => x - y } ) // Which one will be called ?
RETURN

FUNCTION TestLambda (lambda AS CalcInt) AS VOID

? "Int", lambda(2,3)
RETURN

FUNCTION TestLambda (lambda AS CalcReal) AS VOID

? "Real",lambda(2,3)
RETURN

The body of the Lambda may also be a single expression, expression list and a statement
list.
Anonymous Method Expressions
These work almost the same as Lambda Expressions.
Take the example below:

FUNCTION TestAnonymous() AS VOID

LOCAL oForm AS Form
oForm := Form{}
oForm:Click += DELEGATE(o AS System.Object, e AS System.EventArgs ) {

System.Windows.Forms.MessageBox.Show("Click from AME 1!")

System.Windows.Forms.MessageBox.Show("Click from AME 2!")

}
oForm:Click += { o,e => System.Windows.Forms.MessageBox.Show("We can
also do this with a Lambda!") }
oForm:ShowDialog()
RETURN

The biggest difference between Lambda Expressions and Anonymous Method

Expressions is that the parameters to Lambda Expressions do not have to be typed. They
will be inferred from the usage. Parameters for Anonymous Method Expressions must
always be typed.

1.6.5 Delegates
1.6.6 Enumeration Types
1.6.7 Events

© 2015- 2019 XSharp BV

 X# Documentation 176

1.6.8 Exceptions and Exception Handling

1.6.9 File System and the Registry
1.6.10 Generics
1.6.11 Indexers
1.6.12 Interfaces
1.6.13 Interoperability
1.6.14 LINQ Query Expressions
1.6.15 Memory Variables
X# provides support for dynamically scoped variables that are created and maintained
completely at runtime.
The term dynamically scoped refers to the fact that the scope of these variables is not
limited by the entity in which the variable is created.

Warning! Dynamically scoped variables are NOT supported in the Core and Vulcan
dialects. In other dialects they are supported only if the -memvar compiler option is
enabled.

Variable Type Lifetime Visibility

PRIVATE Until creator returns or until Creator and called routines
released
PUBLIC Application or until released Application
The data type of a dynamically scoped variable changes according to the contents of the
variable. For this reason they are often described as dynamic or polymorphic.
Dynamically scoped variables are provided mainly for Clipper/Xbase compatibility;
however, they are very useful in certain circumstances. For instance, they let you develop
rapid prototypes and have certain inheritance properties that you may find hard to resist.
You must be aware, however, that using them comes at a cost. Consider these points:
· Because they are not resolved at compile time, these variables require overhead in the
form of runtime code, making your application larger and slower than necessary.
· No compile time checking for type compatibility is possible with these variables.
· Using the inheritance properties of these variables defies one of the basic tenets of
modular programming and may lead to maintenance and debugging problems down the
line. Furthermore, this practice will make the transition to lexically scoped and typed
variables more difficult.
This section explores dynamically scoped variables fully, but X# has several options for
variable declarations that you will want to explore before choosing to use this variable
class. The next two sections in this chapter introduce you to Lexically Scoped Variables
and Strongly Typed Variables, which you may find useful.
Important! For the sake of illustration, some of the examples in this section use
unorthodox programming practices. Using the inheritance properties of public and private
variables instead of passing arguments and returning values is not recommended.
Private
Private is one of the two types of dynamically scoped variables, and there are several
ways to create a private variable:

© 2015- 2019 XSharp BV

177 XSharp Bandol

· List the variable name as part of a PRIVATE statement. If you do not make an
assignment at this time, the variable takes on the NIL value and data type; otherwise, it
takes on the data type of its assigned value. You can assign a new value (with a new
datatype) to a variable at any time:
PRIVATE X := 10, y
This creates x as a numeric variable and y as an untyped variable with the value NIL.
You can later change the values and their types by assigning other values to them:
X := "X# Is great"
Y := Today()
· List the variable name as part of a PARAMETERS statement within a FUNCTION,
PROCEDURE or METHOD definition. The variable takes on the data type of its
associated argument when the routine is called, or NIL if the argument is omitted. You
can assign a new value (and a new data type) to the variable at any time.
· Assign a value to a non-existent variable name (for example, x := 10). The variable takes
on the data type of its assigned value until you assign a new value to it. (x is numeric,
but the assignment x := "Ms. Jones" changes it to a string.) This will only work if you
have used the -undeclared as well as the -memvar commandline options.
Private variables have these properties:
· You can access them within the creating routine and any routines called by the creator.
In other words, private variables are automatically inherited by called routines without
having to pass them as arguments.
· You can hide them from a called routine by explicitly creating a private (using PRIVATE
or PARAMETERS) or declaring a local (using LOCAL) variable with the same name in
the called routine.
· They are automatically released from memory when the creator returns to its calling
routine, or you can release them explicitly using RELEASE, CLEAR ALL, or CLEAR
MEMORY.
In this example, the function Volume() expects three arguments, or parameters, to be
passed. When the function is called, it creates three private variables, nLength, nWidth,
and nHeight to accept the arguments. Because they are created with the PARAMETERS
statement, any higher-level variables (either public or private) created with these names
are temporarily hidden, preventing their values from being overwritten in memory:

FUNCTION Volume()
PARAMETERS nLength, nWidth, nHeight
RETURN nLength * nWidth * nHeight

In the next example, a modified version of Volume() creates a private variable (assuming
no other variable name nVolume is visible) to store its return value. If the variable nVolume
exists prior to calling Volume() and is visible to Volume() (for example, nVolume may be
public or private to the routine that called Volume()), its value is overwritten in memory and
will remain changed when the function returns to its calling routine:

FUNCTION Volume()
PARAMETERS nLength, nWidth, nHeight
nVolume := nLength * nWidth * nHeight
RETURN nVolume

In this version, Volume() specifies the nVolume variable as PRIVATE. Doing this
temporarily hides any higher-level variable (either public or private) with the same name,
preventing its value from being overwritten in memory:

© 2015- 2019 XSharp BV

 X# Documentation 178

FUNCTION Volume()
PARAMETERS nLength, nWidth, nHeight
PRIVATE nVolume := nLength * nWidth * nHeight
RETURN nVolume

Public
The second category of undeclared variable is public. Public variables have application-
wide lifetime and visibility, and you can define them in only one way:
· List the variable name as part of a PUBLIC statement. If you do not make an
assignment at this time, the variable takes on a value of FALSE (or NIL for array
elements); otherwise, it takes on the data type of its assigned value. You can assign a
new value (and a new data type) to the variable at any time.
Public variables have these properties:
· Once they are created, you can access them anywhere in the application. In other
words, public variables are automatically inherited by all routines in the application
without having to pass them as arguments or post them as return values.
· You can hide them from a routine by explicitly creating a private (using PRIVATE or
PARAMETERS) or declaring a local (using LOCAL) variable with the same name.
· They are not released from memory until you explicitly release them using RELEASE,
CLEAR ALL, or CLEAR MEMORY.
In this example, the function Volume() is defined without arguments. Instead, the calling
routine, Compute(), creates three public variables, nLength, nWidth, and nHeight that are
automatically visible to Volume():

PROCEDURE Compute()
PUBLIC nLength := 5, nWidth := 2, nHeight := 4
? Volume() // Result: 40

FUNCTION Volume()
RETURN nLength * nWidth * nHeight

In the next example, a modified version of Volume() creates a public variable to store the
computed volume, getting around having to return a value to the calling routine. Since
nVolume is public, it is not released from memory when Volume() returns:

PROCEDURE Compute()
PUBLIC nLength := 5, nWidth := 2, nHeight := 4
Volume()
? nVolume // Result: 40 , this will only compile with -undeclared
RETURN

PROCEDURE Volume()
PUBLIC nVolume
nVolume := nLength * nWidth * nHeight
RETURN

A better solution for the use of the nVolume variable from last example that will not require
the -undeclared commandline option is:

© 2015- 2019 XSharp BV

179 XSharp Bandol

PROCEDURE Compute()
PUBLIC nLength := 5, nWidth := 2, nHeight := 4
MEMVAR nVolume // tell the compiler that nVolume is a Public or private
Volume()
? nVolume // Result: 40
RETURN

or

PROCEDURE Compute()
PUBLIC nLength := 5, nWidth := 2, nHeight := 4
Volume()
? _MEMVAR->nVolume // Result: 40
RETURN

Please note that this kind of programming is NOT recommended.

Variable References
Once a public or private variable is created as demonstrated in the previous two sections,
you obtain its value by referring to its name. You might display the value of a variable using
a built-in command or function:

? nVolume
QOut(nVolume)

or use its value as part of an expression:

Str(nVolume, 10, 2) + " cubic feet"

For dynamically scoped variables, you can use the _MEMVAR alias to qualify a variable
reference. In some cases, you may have to do this in order to help the compiler resolve
what might otherwise be an ambiguous reference (for example, if you have a field variable
with the same name as a memory variable and want to use the memory variable in an
expression).
Note: MEMVAR is an abbreviation for memory variable, a term that is synonymous with
dynamically scoped variable.
Assuming that the database file Measures has fields named nLength, nWidth, and
nHeight, this example calls Volume() using the field variable values:

FUNCTION Calculate()
PRIVATE nLength := 5, nWidth := 2, nHeight := 3
USE measures
? Volume(nLength, nWidth, nHeight)
...

To force the function to use the private variables instead of the field variables,
you could use the _MEMVAR-> (or, more simply, M->) alias to qualify the
variable names:

© 2015- 2019 XSharp BV

 X# Documentation 180

FUNCTION Calculate()
PRIVATE nLength := 5, nWidth := 2, nHeight := 3
USE measures
? Volume(_MEMVAR->nLength, _MEMVAR->nWidth, _MEMVAR->nHeight)
...

Of course, it is better to avoid ambiguous situations like the one described above by taking
care to have unique field and variable names, but the point is that the compiler has certain
default rules for handling ambiguous references. If you do not want to be at the mercy of
those defaults, it is best to qualify variable names in all cases.
MEMVAR Declarations
Although you may hear them referred to as such, the statements mentioned so far in the
discussion of dynamically scoped variables are not declarations. The term declaration
refers to a statement whose purpose is to inform the compiler of something—PRIVATE,
PARAMETERS, and PUBLIC are statements that generate memory variables at runtime.
In fact you never have to declare a dynamically scoped variable to the compiler, which is
the reason for their inefficiency. Because they are not created using compile-time
declaration statements, the compiler has to generate runtime code for handling such
issues as type translation, memory management, and resolving ambiguous references to
variable names since it is possible for several variables with the same name to be visible
at one time.
You can, however, declare dynamically scoped variables with the MEMVAR statement and
they will be created as PRIVATE variables:

FUNCTION Calculate()
MEMVAR nLength, nWidth, nHeight
nLength := 5
nWidth := 2
nHeight := 3
USE measures
? Volume(nLength, nWidth, nHeight)

...
In this case, the MEMVAR statement causes memory variables to take precedence over
field variables with the same names, causing Volume() to be called with the private
variables.
Using MEMVAR to declare dynamically scoped variable names to the compiler may make
your programs slightly more efficient (especially if you have lots of ambiguous
references); however, it will not eliminate the runtime overhead of these variables.

1.6.16 Namespaces
1.6.17 Nullable Types
1.6.18 Statements, Expressions and Operators
1.6.19 Strings
1.6.20 Types

© 2015- 2019 XSharp BV

 181 XSharp Bandol

1.6.21 Unsafe Code and Pointers

1.6.22 XML Documentation Comments

1.7 X# Reference
1.7.1 X# Language Reference
This section is a reference to the X# language

X# Language elements
The following table shows reference topics that provide tables of keywords, symbols and
literals used as tokens in X#.

Title Description
Contains links to information about all X#
Keyword Reference (X#)
language keywords.
Contains a table of symbols and operators
Symbol and Operator Reference (X#)
that are used in the X# language.
Describes the syntax for literal values in X#
Literals (X#) and how to specify type information for X#
literals.

1.7.1.1 X# Keywords
The table below has the keywords that are available in the X# language.
· The Keywords in the VO column find their origin in the Visual Objects language. When
the compiler dialect is set to VO then these keywords may be abbreviated (4 letter
minimum)
· The Keywords in the VN column were introduced in Vulcan.NET. These keywords may
never be abbreviated, and most of these keywords are positional, so are only
recognized in certain positions in the language. That also means that these keywords
may be used as Variable Names or Method names
· The Keywords in the X# column were introduced in X#. Just like the VN keywords they
may never be abbreviated and they are also positional.
· Keywords that are listed in the Id column may also be used as an identifier. These are
so called "context sensitive" keywords. You may see in the Visual Studio editor that
these keywords will change color depending on the position in the source.
For example if you start typing PROPERTY the word will be shown in the IDENTIFIER
color:

© 2015- 2019 XSharp BV

 X# Documentation 182

But as soon as you continue to complete the PROPERTY definition it will get the
KEYWORD color:

Descripti
Keyword VO VN X# Id Topic
on
Class and
ABSTRAC
Y Y Modifiers Member
T
Modifier
Class
ACCESS Y Entities
Member
REMOVE
ADD Y Y Entities Part of an
Event
Part of
VOSTRUC
ALIGN Y Y Entities
T
declaration
Character
Encoding
_DLL
ANSI Y Y flag for
Functions
_DLL
declaration
XBase
XBase
ARRAY Y Specific
datatype
Types
Statement Part of
s, type
AS Y
Parameter specificati
s on

© 2015- 2019 XSharp BV

183 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
Sort order
ASCENDI LINQ
Y Y in LINQ
NG Queries
query
Calling
Calling
Conventio
ASPEN Y Y Conventio
n
ns
(obsolete)
Global
ASSEMBL
Y Attributes Attribute
Y
Target
Class
ASSIGN Y Entities
Member
Entity
Modifier for
Statement
ASYNC Y Y Async
s
Processin
g
Character
Encoding
flag for
_DLL
declaration
_DLL
AUTO Y Y . Also part
Functions
of
PROPER
TY
declaration
.
Expressio
n modifier
Statement
AWAIT Y Y for Async
s
Processin
g
Indicates
Statement
BEGIN Y the start of
s
a Block
Breaks out
of the
current
Statement
BREAK Y Begin
s
Sequence
.. END
block

© 2015- 2019 XSharp BV

 X# Documentation 184

Descripti
Keyword VO VN X# Id Topic
on
Part of the
LINQ "GROUP
BY Y Y
Queries BY" clause
in LINQ
Native Native
BYTE Y
Types Type
Calling
Calling
CALLBAC Conventio
Y Y Conventio
K n
ns
(obsolete)
CASE
clause of
DO CASE
Statement statement.
CASE Y
s Also CASE
cause of
SWITCH
statement.
CATCH
Statement clause of
CATCH Y
s TRY
statement
Call
function
through
Pseudo Pointer
CCALL Y
Functions (untyped)
with strict
calling
convention
Call
function
through
CCALLNA Pseudo Pointer
Y
TIVE Functions (untyped)
with strict
calling
convention
Native Native
CHAR Y Y
Types Type
Indicate
Statement
that code
CHECKE s,
Y Y in
D Expressio
expression
ns
or block

© 2015- 2019 XSharp BV

185 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
should not
be
checked
for
overflow
Part of
CLASS Y Entities CLASS
declaration
Calling
Conventio
n (All
Calling
parameter
CLIPPER Y Y Conventio
s are
ns
USUALs
and
Optional)
XBase XBase
CODEBL
Y Specific Specific
OCK
Types Type
Class
CONST Y Y Entities Member
modifier
CONSTR Class
Y Entities
UCTOR Member
XBase XBase
DATE Y Specific Specific
Types Type
DECLARE
METHOD,
Statement
DECLARE Y Y ACCESS,
s
ASSIGN
(obsolete)
Pragma #Pragma
Statement command,
DEFAULT Y Y s, DEFAULT
Expressio expression
ns .
DEFINE Y Y Entities Constant
User
DELEGAT
Y Y Entities Defined
E
Type
DESCEN LINQ Sort order
Y Y
DING Queries in LINQ

© 2015- 2019 XSharp BV

 X# Documentation 186

Descripti
Keyword VO VN X# Id Topic
on
query
DESTRUC Class
Y Entities
TOR Member
Part of
Statement
DIM Y Y variable
s
declaration
Part of
function/pr
DLLEXPO
Y Y Entities ocedure
RT
declaration
(obsolete)
DO CASE
and DO
Statement
DO Y WHILE
s
statement
s
FOR
Statement
DOWNTO Y Y NEXT
s
statement
Native Native
DWORD Y
Types Type
Native Native
DYNAMIC Y Y
Types Type
Statement IF
ELSE Y
s Statement
Statement IF
ELSEIF Y
s Statement
End for
many
Statement
END Y (block)
s
statement
s
Statement DO CASE
ENDCASE Y
s statement
DO
Statement
ENDDO Y WHILE
s
statement
Statement IF
ENDIF Y
s statement
User
ENUM Y Y Entities
Defined

© 2015- 2019 XSharp BV

187 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
Type
Part if
LINQ
EQUALS Y Y LINQ
Queries
Query
Class
EVENT Y Y Entities
Member
Exit
current
Statement FOR, DO
EXIT Y
s WHILE or
REPEAT
loop
Modifier for
EXPLICIT Y Y Modifiers
Operator
Class
EXPORT Y Modifiers member
modifier
Class
EXTERN Y Y Modifiers member
modifier
Logic
FALSE Y Literals
Literal
Calling
Calling
FASTCAL Conventio
Y Y Conventio
L n
ns
(obsolete)
Database
Statement
FIELD Y Y field
s
declaration
TRY ..
Statement
FINALLY Y FINALLY
s
statement
BEGIN
Modifiers,
FIXED and
FIXED Y Y Statement
Variable
s
modifier
XBase XBase
FLOAT Y Specific Specific
Types Type

Statement FOR
FOR Y
s NEXT

© 2015- 2019 XSharp BV

 X# Documentation 188

Descripti
Keyword VO VN X# Id Topic
on
statement
FOREACH
Statement
FOREACH Y Y IN NEXT
s
statement
FROM
LINQ clause in
FROM Y Y
Queries LINQ
Queries
Function
FUNC Y Y Entities
declaration
FUNCTIO Function
Y Entities
N declaration
GET Part
GET Y Y Entities of a
Property
Global field
GLOBAL Y Y Entities
declaration
Part of the
LINQ "GROUP
GROUP Y Y
Queries BY" clause
in LINQ
Class
HIDDEN Y Modifiers member
modifier
IF
Statement
Statement
and
IF Y s, Pseudo
IF(..,..,..)
Functions
Immediate
IF
Pseudo Immediate
IIF Y
Functions IF
Part of
IMPLEME
Y Y Entities CLASS
NTS
declaration
Modifier for
IMPLICIT Y Y Modifiers
Operator

Variable
Statement
IMPLIED Y Y declaration
s
with

© 2015- 2019 XSharp BV

189 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
implied
type
FIELD
declaration
Workarea,
,
IN Y Y LINQ
FOREACH
Queries
IN NEXT
statement
Part of
INHERIT Y Y Entities CLASS
declaration
Class
INITONLY Y Y Modifiers member
modifier
Class
INSTANCE Y Y Fields Member
declaration
Native Native
INT Y
Types Type
Native Native
INT64 Y
Types Type
User
INTERFAC
Y Y Entities Defined
E
Type
INTO
LINQ CLause for
INTO Y Y
Queries LINQ
Queries
Class and
INTERNAL Y Y Modifiers Member
modifier
Statement Part of
s, type
IS Y
Parameter specificati
s on
JOIN
LINQ Clause for
JOIN Y Y
Queries LINQ
Query

LINQ LET
LET Y Y
Queries Clause for

© 2015- 2019 XSharp BV

 X# Documentation 190

Descripti
Keyword VO VN X# Id Topic
on
LINQ
Query
Local
Statement Variable
LOCAL Y
s Declaratio
n
BEGIN
Statement
LOCK Y Y LOCK
s
statement
Native Native
LONG Y
Types Type
Native Native
LONGINT Y
Types Type
Goto start
of FOR,
Statement DO
LOOP Y
s WHILE or
REPEAT
loop
VOSTRUC
MEMBER Y Entities
T fields
dBase
Statement Style
MEMVAR Y
s Variable
declararion
Class
METHOD Y Entities
Member
Global
MODULE Y Y Attributes Attribute
Target
Return
Pseudo Name of
NAMEOF Y Y
Functions parameter
or variable
BEGIN
NAMESPA
Y Y Entities NAMESPA
CE
CE
Class
NEW Y Y Modifiers Member
modifier

© 2015- 2019 XSharp BV

191 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
FOR and
Statement
NEXT Y FOREACH
s
statement
Empty
NIL Y Literals
USUAL
"Do
NOP Y Y Literals Nothing"
statement
Untyped
NULL Y Literals NULL
Literal
Typed
NULL_AR
Y Literals NULL
RAY
Literal
Typed
NULL_CO
Y Literals NULL
DEBLOCK
Literal
Typed
NULL_DA
Y Literals NULL
TE
Literal
Typed
NULL_OB
Y Literals NULL
JECT
Literal
Typed
NULL_PSZ Y Literals NULL
Literal
Typed
NULL_PT
Y Literals NULL
R
Literal
Typed
NULL_ST
Y Literals NULL
RING
Literal
Typed
NULL_SY
Y Literals NULL
MBOL
Literal
Native Native
OBJECT Y
Types Type
Pragma
#Pragma
OFF Y Statement
command
s

© 2015- 2019 XSharp BV

 X# Documentation 192

Descripti
Keyword VO VN X# Id Topic
on
Pragma
#Pragma
ON Y Y Statement
command
s
OPERAT Class
Y Y Entities
OR Member
Pragma
#Pragma
OPTIONS Y Statement
command
s
ORDERB
Y Class in
ORDERB LINQ
Y Y LINQ
Y Queries
Expressio
n
Default
block for
DO CASE
OTHERWI Statement
Y and
SE s
SWITCH
statement
s
Class
OVERRID
Y Y Modifiers Member
E
modifier
Part of
parameter
Parameter
OUT Y type
s
specificati
on
dBase
PARAMET Statement style
Y
ERS s parameter
declaration
Part of
parameter
Parameter
PARAMS Y Y type
s
specificati
on
Class
PARTIAL Y Y Modifiers
modifier
Calling Calling
PASCAL Y Y Conventio Conventio
ns n

© 2015- 2019 XSharp BV

193 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
Call
function
through
Pointer
Pseudo
PCALL Y (untyped)
Functions
with
pascal
calling
convention
Call
function
through
Pointer
PCALLNA Pseudo
Y (untyped)
TIVE Functions
with
pascal
calling
convention
# of
Arguments
received
by
method /
Pseudo
PCOUNT Y function
Functions
with
Clipper
Calling
Conventio
n
Pragma
#pragma
POP Y Statement
Command
s
Class or
Member
Modifiers modifier,
PRIVATE Y ,Statement dBase
s Style
Variable
declararion
Procedure
PROC Y Y Entities
declaration
PROCED Procedure
Y Entities
URE declaration
PROPER Class
Y Y Entities
TY Member

© 2015- 2019 XSharp BV

 X# Documentation 194

Descripti
Keyword VO VN X# Id Topic
on
Class and
PROTECT
Y Modifiers Member
ED
modifier
XBase XBase
PSZ Y Specific Specific
Types Type
Native
Native
PTR Y Type
Types
(unsafe)
Class or
Member
Modifiers, modifier,
PUBLIC Y Statement dBase
s Style
Variable
declararion
Pragma
#pragma
PUSH Y Statement
Command
s
Native Native
REAL4 Y
Types Type
Native Native
REAL8 Y
Types Type
BEGIN
RECOVE Statement SEQUEN
Y
R s CE ...
Statement
Part of
Parameter parameter
REF Y
s specificati
on
REMOVE
REMOVE Y Y Operators Part of an
Event
Statement REPEAT
REPEAT Y
s Statement
Statement RETURN
RETURN Y
s statement

BEGIN
Statement
SCOPE Y Y SCOPE
s
statement

© 2015- 2019 XSharp BV

195 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
Type
SEALED Y Y Modifiers
modifier
SELECT
LINQ clause of
SELECT Y Y
Queries LINQ
Query
Reference
to SELF
object,
Also part
Literals, of
SELF Y Parameter Parameter
s s
declaration
for
Extension
Methods
BEGIN
SEQUEN Statement SEQUEN
Y Y
CE s CE ...
Statement
SET Part
SET Y Y Entities of a
Property
Native Native
SHORT Y
Types Type
SHORTIN Native Native
Y
T Types Type
Calculate
Pseudo
SIZEOF Y the size of
Functions
a type
Class,
Modifiers,
Member of
STATIC Y Statement
Variable
s
Modifier
FOR ..
Statement
STEP Y Y NEXT
s
statement
Calling Calling
STRICT Y Y Conventio Conventio
ns n
Native Native
STRING Y
Types Type

© 2015- 2019 XSharp BV

 X# Documentation 196

Descripti
Keyword VO VN X# Id Topic
on
User
Defined
STRUCT Y Entities
Value
Type
User
STRUCTU Defined
Y Y Entities
RE Value
Type
Reference
SUPER Y Literals to SUPER
class
Statement SWITCH
SWITCH Y Y
s Statement
XBase
xBase
SYMBOL Y Specific
Type
Types
Calling Calling
THISCALL Y Y Conventio convention
ns (obsolete)
FOR
Statement
TO Y NEXT
s
statement
Statement Throw an
THROW Y
s Exception
Logic
TRUE Y Literals
Literal
TRY ...
Statement
TRY Y Y CATCH
s
statement
Pseudo Same as
TYPEOF Y
Functions _TypeOf()
Native Native
UINT64 Y
Types Type
Member
modifier
Modifiers, and BEGIN
UNCHECK
Y Y Statement ..
ED
s UNCHECK
ED
statement

© 2015- 2019 XSharp BV

197 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
Character
Encoding
_DLL
UNICODE Y Y flag for
Functions
_DLL
declaration
User
Defined
UNION Y Y Entities
Value
Type
Member
Modifiers, modifier
UNSAFE Y Y Statement and BEGIN
s .. UNSAFE
statement
Statement REPEAT
UNTIL Y Y
s Statement
FOR
Statement
UPTO Y Y NEXT
s
statement
BEGIN ..
USING
Entities,
statement
USING Y Y Statement
and USING
s
<NameSp
ace>
XBase XBase
USUAL Y Specific Specific
Types Type
Value
place
holder
VALUE Y Y Entities inside
PROPER
TY SET
methods
Variable
declaration
Statement
VAR Y Y with
s
implied
type
Member
VIRTUAL Y Y Modifiers
Modifier

© 2015- 2019 XSharp BV

 X# Documentation 198

Descripti
Keyword VO VN X# Id Topic
on
Native Native
VOID Y
Types Type
Field and
VOLATILE Y Y Modifiers Variable
modifier
User
Defined
VOSTRUC Value Type
Y Y Entities
T with VO
semantics
(AS/IS)
Pragma
WARNING #Pragma
Y Statement
S command
s
Calling
Calling
Conventio
_WINCALL Y Y Conventio
n
ns
(obsolete)
WHERE
Clause in
LINQ
WHERE Y Y LINQ
Queries
Expressio
ns
DO
Statement
WHILE Y WHILE ..
s
Statement
Native Native
WORD Y
Types Type
YIELD ..
EXIT and
Statement YIELD ..
YIELD Y Y
s RETURN
statement
s
Varargs
local
variable for
__ARGLIS
Y Operators functions
T
with ...
(Ellipses)
parameter
Logical
_AND Y Operators
Operator

© 2015- 2019 XSharp BV

199 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
Cast
_CAST Y Operators
operator
XBase
_CODEBL xBase
Y Specific
OCK Type
Types
_DLL
_DLL Y Entities
Function
Statement Field prefix
_FIELD Y
s to
Gets
Parameter
in
_GETFPA Pseudo method/fu
RAM Functions nction with
Clipper
calling
convention
Gets
Parameter
in
_GETMPA Pseudo method/fu
RAM Functions nction with
Clipper
calling
convention
_INIT1,
Procedure
_INIT2, Y Entities
statement
_INIT3
Logical
_NOT Y Operators
Operator
Logical
_OR Y Operators
Operator
Calculate
Pseudo
_SIZEOF Y size of
Functions
type
Calculate
Pseudo
_TYPEOF Y type of
Functions
variable
Logical
_XOR Y Operators
Operator
Logical
.AND. Y Operators
Operator

© 2015- 2019 XSharp BV

 X# Documentation 200

Descripti
Keyword VO VN X# Id Topic
on
Logic
.F. Y Literals
Literal
Logical
.NOT. Y Operators
Operator
Logical
.OR. Y Operators
Operator
Logic
.T. Y Literals
Literal
Logical
.XOR. Y Operators
Operator
Ellipses
Parameter
... Y (varargs)
s
parameter
Preproces
#comman Preproces
Y sor
d sor
Directives
Preproces
Preproces
#define Y sor
sor
Directives
Preproces
Preproces
#else Y sor
sor
Directives
Preproces
Preproces
#endif Y sor
sor
Directives
Preproces
Preproces
#endregion Y sor
sor
Directives
Preproces
Preproces
#ifdef Y sor
sor
Directives
Preproces
Preproces
#ifndef Y sor
sor
Directives
Preproces
Preproces
#include Y sor
sor
Directives
Preproces
Preproces
#line Y sor
sor
Directives

© 2015- 2019 XSharp BV

 201 XSharp Bandol

Descripti
Keyword VO VN X# Id Topic
on
Pragma
Preproces
#pragma Y Statement
sor
s
Preproces
Preproces
#region Y sor
sor
Directives
Preproces
Preproces
#translate Y sor
sor
Directives
Preproces
Preproces
#undef Y sor
sor
Directives
Obsolete:
Namespac
#using Y use USING
e
in stead
Preproces
Preproces
#warning Y sor
sor
Directives
Preproces
#xcomma Preproces
Y sor
nd sor
Directives
Preproces
Preproces
#xtranslate Y sor
sor
Directives

1.7.1.1.1 Types

The X# language knows the following data types

Type Description
Native Types
xBase Specific Types
User Defined Types

© 2015- 2019 XSharp BV

 X# Documentation 202

1.7.1.1.1.1 Simple (Native) Types

By simple data types we mean data types that are not primarily used to hold other data,
e.g. Objects, Structures, Arrays, etc., that we will see later.

Most data types are identical across all .Net languages. This contributes to the ease with
which one can use assemblies written in different .Net languages within one application,
one of the main The simple data types come in various categories; some include several
types. The following table just groups data types by category:

Type Category .Net Name Size in Bits

BYTE Unsigned Integer Byte 8
CHAR Character Char 16
DWORD Unsigned Integer UInt32 32
DECIMAL Numeric Decimal 96
DYNAMIC Multi purpose Dynamic Reference (32 or 64
bits)
INT Signed Integer Int32 32
INT64 Signed Integer Int64 64
LOGIC Logic Boolean 8
LONGINT Signed Integer Int32 32
OBJECT Multi purpose Object Reference (32 or 64
bits)
PTR Multi purpose Intptr Reference (32 or 64
bits)
REAL4 Floating Point Single 32
REAL8 Floating Point Double 64
SBYTE Signed Integer SByte 8
SHORT Signed Integer Int16 16
STRING String String Reference (32 or 64
bits)
UINT64 Unsigned Integer Uint64 64
VOID Not a type Void 0
WORD Unsigned Integer UInt16 16

The BYTE keyword denotes an integral type that stores unsigned 8-bit values with values
that range from 0 to 255.

© 2015- 2019 XSharp BV

203 XSharp Bandol

The CHAR keyword denotes an type to represent a Unicode character. The Unicode
Standard identifies each Unicode character with a unique 21-bit scalar number called a
code point, and defines the UTF-16 encoding form that specifies how a code point is
encoded into a sequence of one or more 16-bit values. Each 16-bit value ranges from
hexadecimal 0x0000 through 0xFFFF and is stored in a Char structure. The value of a
Char object is its 16-bit numeric (ordinal) value.

The DECIMAL keyword describes the .Net System.Decimal type.

The Decimal value type represents decimal numbers ranging from positive
79,228,162,514,264,337,593,543,950,335 to negative
79,228,162,514,264,337,593,543,950,335. The Decimal value type is appropriate for
financial calculations that require large numbers of significant integral and fractional digits
and no round-off errors. The Decimal type does not eliminate the need for rounding.
Rather, it minimizes errors due to rounding. For example, the following code produces a
result of 0.9999999999999999999999999999 instead of 1.

The DWORD keyword denotes an integral type that stores unsigned 32-bit values with
values ranging from 0 to 4,294,967,295.

The dynamic type enables the operations in which it occurs to bypass compile-time type
checking. Instead, these operations are resolved at run time. The dynamic type simplifies
access to COM APIs such as the Office Automation APIs, and also to dynamic APIs such
as IronPython libraries, and to the HTML Document Object Model (DOM).

Type dynamic behaves like type object in most circumstances. However, operations that
contain expressions of type dynamic are not resolved or type checked by the compiler.
The compiler packages together information about the operation, and that information is
later used to evaluate the operation at run time. As part of the process, variables of type
dynamic are compiled into variables of type object. Therefore, type dynamic exists only at
compile time, not at run time.

Please not that to use the DYNAMIC type in your app you have to include the
Microsoft.CSharp DLL at this moment, and the property names and method names are
case sensitive at this moment.

The INT or LONG keyword denotes an integral type that stores signed 32-bit values with
values that range from negative 2,147,483,648 (which is represented by the
Int32.MinValue constant) through positive 2,147,483,647 (which is represented by the
Int32.MaxValue constant) The .NET Framework also includes an unsigned 32-bit integer
value type, UInt32 or DWORD, which represents values that range from 0 to
4,294,967,295.

The INT64 keyword denotes an integral type that stores signed 64-bit values with values
that range from negative 9,223,372,036,854,775,808 through positive
9,223,372,036,854,775,807

© 2015- 2019 XSharp BV

 X# Documentation 204

The LOGIC keyword represents the .Net Boolean type. This type can have either of two
values: true, or false.

The OBJECT keyword is a generic type from which all objects in .Net automatically inherit.

X# does not require a class to declare inheritance from Object because the inheritance is
implicit.

Because all classes in the .NET Framework are derived from Object, every method
defined in the Object class is available in all objects in the system. Derived classes can
and do override some of these methods, including:

· Equals - Supports comparisons between objects.

· Finalize - Performs cleanup operations before an object is automatically reclaimed.

· GetHashCode - Generates a number corresponding to the value of the object to support

the use of a hash table.

· ToString - Manufactures a human-readable text string that describes an instance of the

class.

The PTR keyword denotes an integral type that stores a pointer to a memory location. It is
usually compiled to the System.IntPtr .Net Type.
Please note that the size of the PTR depends on the underlying operating system and it
will also be different when your application runs in x86 or x64 mode.
In Visual Objects PTR is always 32 bits. Many people have written code that CAST INT
values to PTR and back. This works because both values are 32 bit in VO.
Safe code in .Net cannot do this, since the size of PTR is not fixed.

The REAL4 keyword denotes a single precision 32 bit number with values ranging from
negative 3.402823e38 to positive 3.402823e38, as well as positive or negative zero,
PositiveInfinity, NegativeInfinity, and not a number ( NaN). It is intended to represent values
that are extremely large (such as distances between planets or galaxies) or extremely
small (such as the molecular mass of a substance in kilograms) and that often are
imprecise (such as the distance from earth to another solar system). The REAL4 type
complies with the IEC 60559:1989 (IEEE 754) standard for binary floating-point arithmetic.

The REAL8 keyword denotes an double precision 64-bit number with values ranging from
negative 1.79769313486232e308 to positive 1.79769313486232e308, as well as positive
or negative zero, PositiveInfinity, NegativeInfinity, and not a number ( NaN). It is intended to
represent values that are extremely large (such as distances between planets or galaxies)
or extremely small (the molecular mass of a substance in kilograms) and that often are
imprecise (such as the distance from earth to another solar system), The Double type
complies with the IEC 60559:1989 (IEEE 754) standard for binary floating-point arithmetic.

© 2015- 2019 XSharp BV

 205 XSharp Bandol

The SBYTE keyword denotes an integral type that stores signed 8-bit values with values
ranging from negative 128 to positive 127.

The SHORT keyword denotes an integral type that stores signed 16-bit values with values
ranging from negative 32768 through positive 32767.

A STRING is a sequential collection of Unicode characters that is used to represent text. A

String object is a sequential collection of System.Char objects that represent a string. The
value of theString object is the content of the sequential collection, and that value is
immutable (that is, it is read-only). For more information about the immutability of strings,
see the Immutability and the StringBuilder class section later in this topic. The maximum
size of a String object in memory is 2 GB, or about 1 billion characters.

Please note that you cannot CAST strings to PSZ like you can in Visual Objects. The PSZ
type consists of 8 bits per character where the STRING type has 16 bits per character.

The UINT64 keyword denotes an integral type that stores unsigned 64-bit values with
values ranging from 0 to 18,446,744,073,709,551,615.

VOID specifies a return value type for a function or method that does not return a value.
Procedures implicitly define a return type of VOID

The WORD keyword denotes an integral type that stores unsigned 16-bit values with
values ranging from 0 to 65535.

1.7.1.1.1.2 xBase Specific Types

Type Description
ARRAY
CODEBLOCK
DATE
FLOAT
PSZ
SYMBOL
USUAL

The ARRAY type is a dynamic array of USUAL values. Each element of the array may
contain another array, so arrays can be multidimensional.

© 2015- 2019 XSharp BV

 X# Documentation 206

The codeblock type was introduced in the XBase language in the Clipper days.
They can be seen like unnamed functions. They can have 0 or more parameters and
return a value.
The most simple codeblock that returns a string literal looks like this

FUNCTION Start() AS VOID

LOCAL cb AS CODEBLOCK
cb := {|| "Hello World"}
? Eval(cb)
WAIT

RETURN

To use a codeblock you call the Eval() runtime function

Codeblocks are not restricted to fixed expressions, because they can use parameters.
The following codeblock adds 2 parameters.

FUNCTION Start() AS VOID

LOCAL cb AS CODEBLOCK
cb := {|a,b| a + b}
? Eval(cb, 1,2)
? Eval(cb, "Helllo ", "World")
WAIT
RETURN

As you can see in the example, we can both use numeric parameters here or string
parameters. Both work. That is because the parameters to a codeblock are of the so
called USUAL type. They can contain any value. Of course the following will fail because
the USUAL type does not support multiplying strings:

FUNCTION Start() AS VOID

LOCAL cb AS CODEBLOCK
cb := {|a,b| a * b}
? Eval(cb, 1,2)
? Eval(cb, "Helllo ", "World")
WAIT
RETURN

More complicated codeblocks

Codeblocks are not restricted to single expressions.
They may also contain a (comma seperated) list of expressions. The value of the last
expression is the return value of the codeblock:

FUNCTION Start() AS VOID

LOCAL cb AS CODEBLOCK
cb := {|a,b,c| QOut("value 1", a) , QOut("value 2", b), QOut("value 3", c),
a*b*c}
? Eval(cb,10,20,30)

© 2015- 2019 XSharp BV

207 XSharp Bandol

WAIT
RETURN

XSharp has also introduced codeblocks that contain of (lists of ) statements:

FUNCTION Start() AS VOID

LOCAL cb AS CODEBLOCK
cb := {| a,b,c|
? "value 1" ,a
? "value 2" ,b
? "value 3" ,c
RETURN a*b*c
}
? Eval(cb,10,20,30)
WAIT
RETURN

Please note
· The first statement should start on a new line after the parameter list
· There should be NO semi colon after the parameter list.
· The statement list should end with a RETURN statement.

The DATE type is an integral type that stores a date value.

The DATE is internally stored in 3 fields (DAY, MONTH and YEAR) that occupy a total of
32 bits in memory.

The FLOAT type is a type that stores a 64-bit floating point value, along with formatting
information. The precision and range of a FLOAT are the same as that from a REAL8,
since the value of the float is stored in a REAL8.

The PSZ type is a pointer type that points to a null terminated sequence of zero or more
bytes, typically representing a printable character string. This type is for backward
compatibility only. Don't use this type in new code unless you have to.

The SYMBOL type is a 32-bit integer that represents an index into an array of strings.

Since a SYMBOL represents a string, there is a built-in implicit conversion from SYMBOL
to STRING, and from STRING to SYMBOL.

Since the underlying value of a SYMBOL is an integer, there is a built-in explicit conversion
from SYMBOL to DWORD and from DWORD to SYMBOL. A cast is necessary in order
to perform explicit conversions.

Unlike with Visual Objects, the number of symbols is not limited by available memory or
symbols that are declared in another library.

Literal symbols consist of the '#' character followed by one or more alphanumeric
character. The first character must be a letter or an underscore.

Some examples of literal symbols are shown below:

© 2015- 2019 XSharp BV

 X# Documentation 208

#XSharp
#XSHARP

Note that although literal symbols can be specified with lower or upper case letters, the
strings they represent are converted to uppercase at compile time, for compatibility with
Visual Objects. It is not possible to specify a literal symbol that contains lower case
letters, the StringToAtom() function must be used.

The compiler-defined constant NULL_SYMBOL can be used to express a null symbol, i.e.
a symbol that has no associated string value.

The USUAL type is datatype that can contain any data type. It consists internally of a type
flag and a value. This type can store any value.
The compiler treats this type in a special way. The compiler will not warn you when you
assign a value of type USUAL to another type, but will automatically generate the
necessary conversion operation/

USUAL is provided primarily for compatibility with untyped code. It is not recommended for
use in new code because the compiler cannot perform any type checking on expressions
where one or more operands are USUAL. Any data type errors will only be discovered at
runtime.

Locals, parameters and fields declared as USUAL also incur considerably more runtime
overhead than strongly typed variables.

The literal value NIL may be assigned into any storage location typed as USUAL. The
value NIL indicates the absence of any other data type or value, and is conceptually
equivalent to storing NULL into a reference type. NIL is the default value for a local USUAL
variable that has not been initialized.

When the left operand of the ':' operator is a USUAL, the compiler will generate a late
bound call to the method, field or property specified as the right operand. This call may fail
if the value contained in the USUAL at runtime does not have such a member, the
member type is incorrect or inaccessible, or if the name evaluates to a method and the
number of parameters or their types is incorrect. The /lb compiler option must be enabled
in order to use a USUAL as the left operand of the ':' operator, otherwise a compile-time
error will be raised.

1.7.1.1.1.3 User defined Types

Type Description
CLASS
DELEGATE
ENUM
Generic Types
INTERFACE

© 2015- 2019 XSharp BV

209 XSharp Bandol

Type Description
STRUCTURE
UNION
VOSTRUCT

class : (attributes)? (classModifiers)?

CLASS (nameDot)? identifier typeparameters? //
TypeParameters indicate Generic Class
(INHERIT datatype)?
(IMPLEMENTS datatype (COMMA datatype)*)?
(typeparameterconstraintsclause)* eos // Optional
typeparameterconstraints for Generic Class
(classmember)* // List of
class members (instance variables, methods etc)
END CLASS garbage? eos

Enter topic text here.

Enter topic text here.

delegate : (attributes)? (delegateModifiers)?

DELEGATE (nameDot)? identifier typeparameters?
parameterList? (AS datatype)?
(typeparameterconstraintsclause)* eos

enum : (attributes)? (enumModifiers)?

ENUM (nameDot)? identifier ((AS|INHERIT) datatype)?
eos
(enummember)+
END ENUM? garbage? eos

enummember : (attributes)? MEMBER? identifier (:= expression)? eos

Purpose
Declare a variable or array that is available to the entire application or module.

© 2015- 2019 XSharp BV

 X# Documentation 210

Syntax
[STATIC] GLOBAL <idVar> [:= <uValue>] [AS | IS <idType>]
[STATIC] GLOBAL DIM <ArraySpec> AS | IS <idType>

Arguments
STATIC Restricts the visibility of the global variable to the module in which it is
declared. If omitted, the variable has application-wide visibility.
<idVar> A valid identifier name for the variable. A global variable is an entity
and, as such, shares the same name space as other entities. This
means that it is not possible to have a global variable and a function,
for example, with the same name.
<uValue> A constant value that is assigned to <idVar>. This value can be a literal
representation of one of the data types listed below or a simple
expression involving only operators, literals, and DEFINE constants;
however, more complicated expressions (including class instantiation)
are not allowed.
If <uValue> is not specified, the initial value of the variable depends on
the data type you declare (e.g., NIL if you do not use strong typing, 0
for AS INT, etc.)
DIM <ArraySpec> The specification for a dimensioned array to declare.
<ArraySpec> The specification for a dynamic array to declare.
In both cases, <ArraySpec> is one of the following:
<idArray>[<nElements>, <nElements>, <nElements>]
<idArray>[<nElements>][<nElements>][<nElements>]
All dimensions except the first are optional.
<idArray> is a valid identifier name for the array to declare. For
dynamic arrays, array elements are initialized to NIL. For dimensioned
arrays, the initial value of the elements depends on the data type as
explained above for <uValue>.
<nElements> defines the number of elements in a particular
dimension of an array. The number of dimensions is determined by
how many <nElements> arguments you specify.
<nElements> can be a literal numeric representation or a simple
numeric expression involving only operators, literals, and DEFINE
constants; however, more complicated expressions (such as function
calls) are not allowed.
AS <idType> Specifies the data type associated with the instance variables (called
strong typing). If omitted, the instance variables will be polymorphic
and will have an initial value of NIL.

The valid values for <idType> and the initial values associated with
each are listed in the table below:

Data Type Default/Initial Value

ARRAY NULL_ARRAY
CODEBLOCK NULL_CODEBLOCK
DATE NULL_DATE
LOGIC FALSE
OBJECT NULL_OBJECT
<idClass> NULL_OBJECT
STRING NULL_STRING

© 2015- 2019 XSharp BV

211 XSharp Bandol

SYMBOL NULL_SYMBOL
All numerics 0
USUAL NIL
PSZ NULL_PSZ
PTR NULL_PTR
.
IS <idType> Specifies a VOSTRUCT or UNION data type in which the memory
needed to hold the structure is allocated on the stack (<idStructure> is
the only <idType> allowed with the IS keyword.) See the VOSTRUCT
entry in this guide for more information on data structure memory
allocation.

Notes
Search order for variables: You can hide a global variable name from a routine by
declaring another variable with the same name (with LOCAL, MEMVAR, or FIELD).
The search order for a variable name is as follows:
1. LOCALs, local parameters, MEMVARs, and FIELDs
2. SELF instance variables (i.e., without <idObject>: prefix in class methods)
3. GLOBALs and DEFINEs

Examples
The following example illustrates using the GLOBAL statement to create a global variable,
a global dimensioned array, and a global dynamic array. The dynamic array, since it is
declared with STATIC GLOBAL, is visible only in the current module:

GLOBAL cAppName := "Accounts Payable" AS STRING

GLOBAL DIM aiValues[2][10] AS INT
STATIC GLOBAL aPoly[100]
...
FUNCTION Start() AS VOID
? "Start of ", cAppName, " application."
AFill(aPoly, 0)
...
? "End of ", cAppName, " application."

See Also
DEFINE, LOCAL

interface : (attributes)? (interfaceModifiers)?

INTERFACE (nameDot)? identifier typeparameters?
((INHERIT|:) datatype)? (, datatype)*
(typeparameterconstraintsclause)* eos //
Optional typeparameterconstraints for Generic Class
(classmember)*
END INTERFACE garbage? eos

© 2015- 2019 XSharp BV

 X# Documentation 212

structure : (attributes)? (structureModifiers)?

STRUCTURE (nameDot)? identifier typeparameters?
(IMPLEMENTS datatype (, datatype)*)?
(typeparameterconstraintsclause)* eos
(classmember)+
END STRUCTURE garbage? eos

union : (votypeModifiers)?
UNION (nameDot)? identifier eos
(vounionmember)+

vounionmember : MEMBER DIM identifier [ arraysub ] ((AS | IS)

datatype)? eos
| MEMBER identifier ((AS | IS) datatype)? eos

vostruct : (votypeModifiers)?
VOSTRUCT (nameDot)? identifier (ALIGN INT_CONST)? eos
(vostructmember)+

vostructmember : MEMBER DIM identifier [ arraysub ] ((AS | IS)

datatype)? eos
| MEMBER identifier ((AS | IS) datatype)? eos

Generic types can be recognized by type parameters and type parameter constraints

typeparameters : < typeparameter (,attributes?

typeparameter)* >

typeparameter : attributes? (IN | OUT)? identifier

typeparameterconstraintsclause : WHERE identifier IS typeparameterconstraint

(, typeparameterconstraint)*

© 2015- 2019 XSharp BV

213 XSharp Bandol

typeparameterconstraint : (CLASS|STRUCTURE) // Class Foo<t>

WHERE T IS (CLASS|STRUCTURE)
| typeName // Class Foo<t>
WHERE T IS Customer
| NEW() // Class Foo<t>
WHERE T IS NEW()

Class members can be methods, properties and many more :

classmember : method
| declare
| constructor
| destructor
| classvars
| property
| operator
| event
| structure // from here are nested types
| class
| delegate
| enum
| interface
| function // synonym to method

| procedure // synonym to method with void return

type
;

Constructors are the equivalent of Init() methods in Visual Objects. They are called when
an object is initialized

constructor : (attributes)?
(constructorModifiers)?
CONSTRUCTOR (parameterList)? (AS VOID)? // As
Void is allowed but ignored
(callingconvention)?
(CLASS (nameDot)? identifier)? eos
((SELF | SUPER)( (LPAREN RPAREN)| (LPAREN
argumentList RPAREN)) eos)?
statementBlock

The declare statement is parsed by X# but ignored

declare : DECLARE (ACCESS | ASSIGN | METHOD ) identifier (,

identifier)* eos

© 2015- 2019 XSharp BV

 X# Documentation 214

Destructors are automatically called by the .Net runtime when an object is disposed. They
are similar to Axit methods in Visual Objects, with a few differences:
· You do not need to call RegisterAxit(). The destructor will always be called
· You cannot not call destructors from your own code.
If you want to be able to control the destruction of objects and call cleanup code from your
own code, then you can either implement a mechanism similar to the Axit() and Destroy()
methods from the VO GUI classes or you implement the Dispose pattern that many .Net
classes use.
Destructors do not have:
· Parameters
· A Return type

destructor : (attributes)?
(destructorModifiers)?
DESTRUCTOR (LPAREN RPAREN)?
(CLASS (nameDot)? identifier)? eos
statementBlock

Events can be used to allow external code to respond to state changes in an object. There
are roughly 3 types of event declarations:
· Auto events, where the compiler sets up the mechanism behind the event
· Single line declarations, with a simple ADD expression(list) and REMOVE
expression(list).
· Multi line declarations with a separate ADD block and/or REMOVE block

event_ : (attributes)? (eventModifiers)?

EVENT (nameDot)? identifier (AS datatype)?
( eos
| (eventLineAccessor)+ eos
| eos (eventAccessor)+ END EVENT? garbage? eos
)

eventLineAccessor : attributes? eventModifiers?

( ADD expressionList?
| REMOVE expressionList?
| (ADD|REMOVE) )

eventAccessor : attributes? eventModifiers?

( ADD eos statementBlock END ADD?
| REMOVE eos statementBlock END REMOVE? )
garbage? eos

© 2015- 2019 XSharp BV

215 XSharp Bandol

There are 3 types of Methods in X#:

· Normal methods. These can have parameters and a return type. X# also allows generic
type parameters
· ACCESS methods, these are mapped to the GET part of a compiler generated
Property. Access methods should always return a value.
· ASSIGN methods, these are mapped to the SET part of a compiler generated Property.
Assign methods should not return a value.

METHOD declarations can appear inside a class block, or outside a class block. Inside a
class block the CLASS <Id> clause is ignored.
Outside of a CLASS block the CLASS <Id> clause is mandatory

method : (attributes)? (memberModifiers)?

methodtype (nameDot)? identifier
typeparameters? (parameterList)? (AS datatype)?
(typeparameterconstraintsclause)*
(callingconvention)?
(CLASS (nameDot)? identifier)? // The class
clause is allowed in X# but not needed when the method is
// between CLASS
.. END CLASS. If you use it then the classname must match the class
// inside which it
is defined
(EXPORT LOCAL)? // Export Local
exists in VO but is ignored in X#
(DLLEXPORT STRING_CONST)? eos // The DLLEXPORT
clause exists in VO but is ignored in X#
statementBlock

methodtype : (METHOD | ACCESS | ASSIGN)

callingconvention : (CLIPPER | STRICT | PASCAL | ASPEN | WINCALL |

CALLBACK | FASTCALL | THISCALL)

/*
From the C# syntax guide:
overloadable-unary-operator: one of
+ - ! ~ ++ -- true false
overloadable-binary-operator:
+ - * / % & | ^ << right-shift == != > < >= <=
// note in C# ^ is binary operator XOR and ~ is bitwise negation (Ones
complement)
// in VO ~is XOR AND bitwise negation. ^is EXP and should not be used
for overloaded ops
// VO uses ^ for Exponent

*/

operator_ : attributes? operatorModifiers?

© 2015- 2019 XSharp BV

 X# Documentation 216

OPERATOR (overloadedOps | conversionOps) GT?

parameterList (AS datatype)? eos
statementBlock

overloadedOps : (PLUS | MINUS | NOT | TILDE | INC | DEC |

TRUE_CONST | FALSE_CONST |
MULT | DIV | MOD | AMP | PIPE | LSHIFT | RSHIFT | EEQ
| NEQ | NEQ2 |
GT | LT | GTE | LTE |
AND | OR ) // these two do not exist in C# and are
mapped to & and |

conversionOps : ( IMPLICIT | EXPLICIT )

Properties can be used to assign and access values of a type. The property syntax allows
to define read only properties and to assign actions to the assignment of a property.
There are roughly 3 types of properties
· Auto properties, where the compiler declares the field backing the property
· Single line declarations, with a simple GET expression and SET expression(list).
· Multi line declarations with a separate GET block and/or SET block

property : (attributes)? (memberModifiers)?

PROPERTY (SELF propertyParameterList | (nameDot)?
identifier)
propertyParameterList)? (AS datatype)?
( AUTO (propertyAutoAccessor)* (:= expression)?
// Auto
| (propertyLineAccessor)+
eos // Single Line
| eos (propertyAccessor)+ eos
// Multi Line
END PROPERTY? garbage? eos

propertyParameterList
: [ (parameter (, parameter)*)? ]
| ( (parameter (, parameter)*)? ) // Allow
Parentheses as well

propertyAutoAccessor: attributes? memberModifiers? (GET|SET)

propertyLineAccessor: attributes? memberModifiers?

( GET expression?
| SET expressionList?
| (GET|SET) )

© 2015- 2019 XSharp BV

 217 XSharp Bandol

propertyAccessor : attributes? memberModifiers?

( GET eos statementBlock END GET?
| SET eos statementBlock END SET? )
garbage? eos

Instance Variables are also known as fields in .NET. They define the values of a type.

classvars : (attributes)? (classvarModifiers)? classVarList eos

classVarList : classvar (, classvar)* (AS | IS) datatype)?

classvar : (DIM)? identifier ([ arraysub ])? (:= expression)?

1.7.1.1.2 Entities

The X# language knows the following entity types. Some of these are also listed as User
Defined Types and Class Members

Keyword VO VN X# Description
_DLL Y
Class Y
Constructor Y (Init) Y
Define Y
Delegate Y
Destructor Y (Axit) Y
Enum Y
Event Y
Function Y
Global Y
Interface Y
Method Y
Namespace Y
Operator Y
Procedure Y
Property Y

© 2015- 2019 XSharp BV

 X# Documentation 218

Keyword VO VN X# Description
Structure Y
Union Y
Using Y
VoStruct Y

1.7.1.1.2.1 Namespace

namespace : BEGIN NAMESPACE name eos

(entity)*
END NAMESPACE garbage? eos

1.7.1.1.2.2 Function

function : (attributes)? (funcprocModifiers)?

FUNCTION identifier typeparameters? (parameterList)?
(AS datatype)?
(typeparameterconstraintsclause)*
(callingconvention)?
(EXPORT LOCAL)? // Export Local
exists in VO but is ignored in X#
(DLLEXPORT STRING_CONST)? eos // The DLLEXPORT
clause exists in VO but is ignored in X#
statementBlock

1.7.1.1.2.3 Procedure

procedure : (attributes)? (funcprocModifiers)?

PROCEDURE identifier typeparameters? (parameterList)?
(AS VOID)? // As Void is allowed but ignored
(typeparameterconstraintsclause)*
(callingconvention)? (INIT1|INIT2|INIT3|EXIT)?
(EXPORT LOCAL)? // Export Local
exists in VO but is ignored in X#
(DLLEXPORT STRING_CONST)? eos // The DLLEXPORT
clause exists in VO but is ignored in X#
statementBlock

© 2015- 2019 XSharp BV

 219 XSharp Bandol

1.7.1.1.2.4 Using

using_ : (#USING|USING) (STATIC)? (identifier := )? name eos

1.7.1.1.2.5 Define

Purpose
Declare a constant name and its value to the compiler.

Syntax
[STATIC] DEFINE <idConstant> := <expression> [ AS <Type>]

Arguments
STATIC Restricts the visibility of the constant to the module in which it is
declared. If omitted, the constant has application-wide visibility.
<idConstant> A valid identifier name for the constant. A constant is an entity and, as
such, shares the same name space as other entities. This means that
it is not possible to have a constant and a global variable, for example,
with the same name.
<expression> A constant value that is assigned to <idConstant>. This value can be a
literal representation of one of the data types listed below or a simple
expression involving only operators, literals, and other DEFINE
constants; however, more complicated expressions (including class
instantiation) are not allowed.
<Type> You can optionally specify a type for a DEFINE. When the type is
omitted then the compiler will calculate the type from <expression>.

Description
Once the constant name and value is declared and initialized with the DEFINE statement,
you can not change the value of <idConstant> without provoking a compiler error. The
constant value <uValue> will be used whenever the <idConstant> identifier name is
encountered in your application.
You can hide a constant name from a routine by declaring a variable with the same name
(with LOCAL, MEMVAR, or FIELD). The search order for a variable name is as follows:
1. LOCALs, local parameters, MEMVARs, and FIELDs
2. SELF instance variables (i.e., without <idObject>: prefix in class methods)
3. GLOBALs and DEFINEs

Note: you can't use DEFINES for #ifdef constructs. You need to use #defines for that.
DEFINEs are like GLOBALs but their value is a constant.

Examples
The following example assigns an application name to the constant cAppName. This
value is then displayed at the beginning and end of the application run:

© 2015- 2019 XSharp BV

 X# Documentation 220

DEFINE cAppName := "Accounts Payable"

...
FUNCTION Start()
? "Start of ", cAppName, " application."
...
? "End of ", cAppName, " application."

See Also
#define , GLOBAL

1.7.1.1.2.6 _DLL

vodll : (attributes)?
(funcprocModifiers)? _DLL
( FUNCTION identifier parameterList (AS datatype)?
| PROCEDURE identifier parameterList )
(dllcallconv)? :
identifierString (. identifierString)?
( REAL_CONST
| . identifierString @? INT_CONST? (#
INT_CONST)?
)
(AUTO | ANSI | UNICODE) ?
eos

1.7.1.1.3 Parameters and others

Several language elements are used on different spots, such as

Type Description
Attributes Special language construct to add meta
information
Parameters Function and/or method parameters
Modifiers Special keywords that determine the scope
and visibility of types and members

1.7.1.1.3.1 Parameters

parameterList : LPAREN (parameter (COMMA parameter)*)? RPAREN

parameter : (attributes)? SELF? identifier (:= expression)?

(parameterDeclMods datatype)?
| ELLIPSIS

© 2015- 2019 XSharp BV

 221 XSharp Bandol

parameterDeclMods : (AS | REF | OUT | IS | PARAMS) CONST?

1.7.1.1.3.2 Attributes

Attributes are used in DotNet to assign meta information to types, members, parameters
etc.

attributes : ( attributeBlock )+

attributeBlock : [ attributeTarget? attribute (, attribute)* ]

attributeTarget : identifier :
| keyword :

attribute : name (LPAREN (attributeParam (, attributeParam)

* )? RPAREN )?

attributeParam : identifier := expression

| expression

globalAttributes : [ globalAttributeTarget attribute (, attribute)* ]

eos

globalAttributeTarget : (ASSEMBLY | MODULE) :

1.7.1.1.3.3 Modifiers

Modifiers are language elements that are used to change the visibility or scope of types,
members etc. They can often be combined.

funcprocModifiers : ( (STATIC | INTERNAL | PUBLIC | EXPORT | UNSAFE) )+

memberModifiers : ( (NEW | PRIVATE | HIDDEN | PROTECTED | PUBLIC |

EXPORT
| INTERNAL | STATIC | VIRTUAL | SEALED | ABSTRACT |
ASYNC | UNSAFE | EXTERN | OVERRIDE) )+

operatorModifiers : ( (PUBLIC | STATIC | EXTERN) )+

© 2015- 2019 XSharp BV

 X# Documentation 222

interfaceModifiers : ( (NEW | PUBLIC | EXPORT | PROTECTED | INTERNAL |

PRIVATE | HIDDEN | UNSAFE | PARTIAL) )+

classModifiers : ( (NEW | PUBLIC | EXPORT | PROTECTED | INTERNAL |

PRIVATE | HIDDEN | ABSTRACT | SEALED
| STATIC | UNSAFE | PARTIAL) )+

structureModifiers : ( (NEW | PUBLIC | EXPORT | PROTECTED | INTERNAL |

PRIVATE | HIDDEN | UNSAFE | PARTIAL) )+

delegateModifiers : ( (NEW | PUBLIC | EXPORT | PROTECTED | INTERNAL |

PRIVATE | HIDDEN | UNSAFE) )+

enumModifiers : ( (NEW | PUBLIC| EXPORT | PROTECTED | INTERNAL |

PRIVATE | HIDDEN) )+

eventModifiers : ( (NEW | PUBLIC | EXPORT | PROTECTED | INTERNAL |

PRIVATE | HIDDEN | STATIC
| VIRTUAL | SEALED | ABSTRACT | UNSAFE) )+

classvarModifiers : ( (INSTANCE| STATIC | CONST | INITONLY | PRIVATE |

HIDDEN | PROTECTED
| PUBLIC | EXPORT | INTERNAL | VOLATILE | UNSAFE |
FIXED) )+

constructorModifiers: ( ( PUBLIC | EXPORT | PROTECTED | INTERNAL | PRIVATE |

HIDDEN | EXTERN | STATIC ) )+

destructorModifiers : ( EXTERN )+

1.7.1.1.3.4 Arguments

Argument lists are used when calling methods or functions that expect parameters.
There are 2 syntaxes. One that allows named arguments (for the Core dialect when
calling functions and methods) and one that does not allow named arguments (used for
Properties). The syntax for these argument lists is:

// NOTE: Separate rule for bracketedarguments because they cannot use

idendifierName syntax

© 2015- 2019 XSharp BV

 223 XSharp Bandol

bracketedArgumentList : unnamedArgument (, unnamedArgument)*

unnamedArgument : expression?

argumentList : namedArgument (, namedArgument)*

// NOTE: Expression is optional so we can skip arguments for VO/Vulcan

compatibility
namedArgument : identifierName := ( (REF | OUT) )? expression?
| ( (REF | OUT) )? expression?

1.7.1.1.3.5 Array Indices

arraysub : expression (] [ expression)+ // x][y

| expression (, expression)+ // x,y
| expression

1.7.1.1.4 Statements

The X# language knows the following statement types

Iteration Statements

Keyword VO VN X# Description
DO WHILE ... Y
FOR ... NEXT Y
FOREACH ...
Y
NEXT
REPEAT ...
Y
UNTIL

Conditional statements

Keyword VO VN X# Description
IF .. ELSE ..
Y
ENDIF
DO CASE Y

© 2015- 2019 XSharp BV

 X# Documentation 224

Keyword VO VN X# Description
SWITCH Y

Other statement types

Keyword VO VN X# Description
Expression
Y
statement
Qout (?,??) Y
NOP Y

Block statements

Keyword VO VN X# Description
BEGIN
Y
CHECKED
BEGIN FIXED Y
BEGIN LOCK Y
BEGIN SCOPE Y
BEGIN
Y
UNCHECKED
BEGIN
Y
UNSAFE
BEGIN USING Y

Jump statements

Keyword VO VN X# Description
ASYNC ...
Y
AWAIT
EXIT Y
LOOP Y

© 2015- 2019 XSharp BV

225 XSharp Bandol

Keyword VO VN X# Description
RETURN Y
YIELD EXIT Y
YIELD
Y
RETURN

Declaration Statements

Keyword VO VN X# Description
FIELD Y
GLOBAL Y
LOCAL Y
LOCAL
Y
IMPLIED
MEMVAR Y
PARAMETERS Y
PRIVATE Y
PUBLIC Y
VAR Y
STATIC
Y
(LOCAL)

Exception Handling

Keyword VO VN X# Description
BEGIN
Y
SEQUENCE
BREAK Y
TRY ... CATCH
Y
.. FINALLY
THROW Y

© 2015- 2019 XSharp BV

 X# Documentation 226

1.7.1.1.4.1 ?, ??

The ? and ?? statements allow to write information to the system console.

The syntax for these statements is

qoutstmt : ? (?)? expression (, expression)*

1.7.1.1.4.2 ASYNC .. AWAIT

ASYNC await are strictly speaking not statements, but modifiers.

ASYNC is a method modifier used to indicate that a method / function contains

asynchronous code

AWAIT is used before an expression to indicate that an operation may take a while to
process.

The compiler will (behind the scenes) construct a complicated mechanism in which the
body of the method is split into a part before and after the await. When the expression
returns then the code jumps to the point where it has to continue. As such this belongs to
the JUMP statements.

1.7.1.1.4.3 BEGIN (UN)CHECKED

BEGIN CHECKED eos

statementBlock
END CHECKED? garbage? eos

BEGIN UNCHECKED eos

statementBlock
END CHECKED? garbage? eos

1.7.1.1.4.4 BEGIN FIXED

BEGIN FIXED variableDeclaration eos

statementBlock
END FIXED? garbage? eos

1.7.1.1.4.5 BEGIN LOCK

BEGIN LOCK expression eos

statementBlock
END LOCK? garbage? eos

© 2015- 2019 XSharp BV

 227 XSharp Bandol

1.7.1.1.4.6 BEGIN SCOPE

BEGIN SCOPE eos

statementBlock
END SCOPE? garbage? eos

1.7.1.1.4.7 BEGIN SEQUENCE

begin sequence : BEGIN SEQUENCE eos

statementBlock
(RECOVER (USING identifier)? eos
(statementBlock ) ?
(FINALLY eos
statementBlock)?
END SEQUENCE? garbage? eos

1.7.1.1.4.8 BEGIN UNSAFE

BEGIN UNSAFE eos

statementBlock
END UNSAFE? garbage? eos

1.7.1.1.4.9 BEGIN USING

BEGIN USING ( expression | variableDeclaration ) eos

statementBlock
END USING? garbage? eos

1.7.1.1.4.10 BREAK

breakstmt : BREAK expression? eos

1.7.1.1.4.11 DO CASE

Purpose
Conditionally execute a block of statements.

© 2015- 2019 XSharp BV

 X# Documentation 228

Syntax
DO CASE
CASE <lCondition>
<Statements>...
[CASE <lCondition>]
<Statements>...
[OTHERWISE]
<Statements>...
END[CASE]

Arguments
<lCondition> If this expression evaluates to TRUE, the statements following it up
until the next CASE, OTHERWISE, or ENDCASE are executed.
Afterwards, control branches to the statement following the next
ENDCASE statement.
OTHERWISE If all preceding CASE conditions evaluate to FALSE, the statements
following the OTHERWISE up until the next ENDCASE are executed.
Afterwards, control branches to the statement following the next
ENDCASE statement.

Description
DO CASE works by branching to the statement following the first CASE <lCondition> that
evaluates to TRUE. If all CASE conditions evaluate to FALSE, it branches to the statement
following the OTHERWISE statement (if specified).
Execution proceeds until the next CASE, OTHERWISE, or ENDCASE is encountered,
and control then branches to the first statement following the next ENDCASE statement.
Control structures can be nested to any depth. The only requirement is that each control
structure be properly nested.
Note: DO CASE...ENDCASE is identical to IF...ELSEIF...ENDIF, with neither syntax
having a performance advantage over the other.

Examples
This example uses DO CASE in a menu structure to branch control based on user
selection:

FUNCTION ActonChoice(nChoice as LONG) AS VOID

DO CASE
CASE nChoice = 0
RETURN
CASE nChoice = 1
ChoiceOne()
CASE nChoice = 2
ChoiceTwo()
ENDCASE

See Also
BEGIN SEQUENCE, DO WHILE, FOR, FOREACH IF SWITCH

© 2015- 2019 XSharp BV

 229 XSharp Bandol

1.7.1.1.4.12 DO WHILE

whilestmt : DO? WHILE expression eos

StmtBlk=statementBlock
(END DO? | ENDDO) garbage? eos

1.7.1.1.4.13 EXIT

The Exit statement unconditionally jumps out of the current DO WHILE, FOR NEXT,
FOREACH NEXT or REPEAT UNTIL block

1.7.1.1.4.14 Expression Statement

Expression Statements are stand alone expressions on a single line. The most common
expression statement types are:

Invocation Expression (Function call, Method Call)

Assignment Expression
Object Creation Expression
Increment and Decrement Expression
Await Expression
Conditional Expression
Conditional Access Expression
(Un)Checked Expression
Parenthesized Expression

1.7.1.1.4.15 FIELD

Purpose
Declare one or more database field names to be used by the current routine.

Syntax
FIELD <idFieldList> [IN <idAlias>]

Arguments
<idFieldList> A list of names to declare as fields to the compiler.
IN <idAlias> An alias to assume when there are unaliased references to the names
specified in the <idFieldList>.

Description
When you use the FIELD statement to declare fields, unaliased references to variables in
<idFieldList> are treated as if they were preceded by the special field alias (_FIELD->) or
<idAlias>-> if the IN clause is specified.

© 2015- 2019 XSharp BV

 X# Documentation 230

Like other variable declaration statements (i.e., LOCAL and MEMVAR), you must place
FIELD statements before any executable statements (including PRIVATE, PUBLIC, and
PARAMETERS) in the routine you are defining. The FIELD statement has no effect on the
macro operator, which always assumes memory variables.
The FIELD statement neither opens a database file nor verifies the existence of the
specified fields. It is useful primarily to ensure correct references to fields that are known
to exist at runtime. Attempting to access the fields when the associated database is not in
use will raise a runtime error.

Examples
This function includes statements to declare database field names in both the current and
Employee work areas:

FUNCTION DisplayRecord()
FIELD CustNo, OrderNo, Orders
FIELD EmpName, EmpCode IN Employee
USE employee NEW
USE orders NEW
? CustNo // Refers to Orders->CustNo
? EmpName // Refers to Employee->EmpName
CLOSE orders
CLOSE employee

See Also
LOCAL, MEMVAR, STATIC

1.7.1.1.4.16 FOR ... NEXT

forstmt: FOR
( expression
| (LOCAL? IMPLIED | VAR) identifier := expression
| LOCAL identifier := expression (AS datatype)?
)
(TO | UPTO | DOWNTO) expression
(STEP expression)? eos
StmtBlk=statementBlock
NEXT garbage? eos

1.7.1.1.4.17 FOREACH ... NEXT

foreachstmt : FOREACH
(IMPLIED identifier
| VAR identifier
| identifier AS datatype )
IN expression eos
statementBlock

© 2015- 2019 XSharp BV

 231 XSharp Bandol

NEXT garbage? eos

1.7.1.1.4.18 IF ... ELSE ... ENDIF

ifstmt : IF expression eos

statementBlock
(ELSEIF expression eos
statementBlock) *
(ELSE eos
statementBlock)?
(END IF? | ENDIF) garbage? eos

1.7.1.1.4.19 LOCAL

Local declarations can appear anywhere in your code, and do not have to be the first lines
in a statement block.
Locals declared within a block are only visible inside that block.
The VAR keyword has been added for ease of use, and because sometimes the type is
difficult to specify, like in the area if LINQ or when anonymous types are used.

Purpose
Declare and initialize local variables and arrays.

Syntax
[STATIC] LOCAL <idVar> [:= <expression>] [,...] [AS | IS <idType>] [, ...]
[STATIC] LOCAL DIM <ArraySpec> [, ...] AS | IS <idType> [, ...]
VAR <idVar> := <expression>
LOCAL IMPLIED <idVar> := <expression>
Note: The LOCAL statement is shown using several syntax diagrams for convenience.
You can declare variables, dynamic arrays, and dimensioned arrays using a single
LOCAL statement if each definition is separated by a comma.

Arguments
STATIC Causes the local variable to retain its value across invocations of the
declaring entity but does not affect its visibility.

<idVar> A valid identifier name for the local variable to declare.

<expression> The initial value to assign to the variable.

For LOCAL, this can be any valid expression.
For STATIC LOCAL, this value can be a literal representation of one of
the data types listed below or a simple expression involving only
operators, literals, and DEFINE constants; however, more complicated
expressions (including class instantiation) are not allowed.

© 2015- 2019 XSharp BV

 X# Documentation 232

If <uValue> is not specified, the initial value of the variable depends on

the data type you declare (e.g., NIL if you do not use strong typing, 0
for AS INT, etc.)

VAR The compiler will calculate the type based on the expression in
<uValue>

LOCAL IMPLIED The compiler will calculate the type based on the expression in
<uValue>

DIM <ArraySpec> The specification for a dimensioned array to declare.

<ArraySpec> The specification for a dynamic array to declare.
In both cases, <ArraySpec> is one of the following:
<idArray>[<nElements>, <nElements>, <nElements>]
<idArray>[<nElements>][<nElements>][<nElements>]
All dimensions except the first are optional.
<idArray> is a valid identifier name for the array to declare. For
dynamic arrays, array elements are initialized to NIL. For dimensioned
arrays, the initial value of the elements depends on the data type as
explained above for <uValue>.
<nElements> defines the number of elements in a particular
dimension of an array. The number of dimensions is determined by
how many <nElements> arguments you specify.
<nElements> can be a literal numeric representation or a simple
numeric expression involving only operators, literals, and DEFINE
constants; however, more complicated expressions (such as function
calls) are not allowed.

AS <idType> Specifies the data type associated with the instance variables (called
strong typing). If omitted, the instance variables will be polymorphic
and will have an initial value of NIL.

The valid values for <idType> and the initial values associated with
each are listed in the table below:

Data Type Default/Initial Value

ARRAY NULL_ARRAY
CODEBLOCK NULL_CODEBLOCK
DATE NULL_DATE
LOGIC FALSE
OBJECT NULL_OBJECT
<idClass> NULL_OBJECT
STRING NULL_STRING
SYMBOL NULL_SYMBOL
All numerics 0
USUAL NIL
PSZ NULL_PSZ
PTR NULL_PTR

IS <idType> Specifies a VOSTRUCT or UNION data type in which the memory

needed to hold the structure is allocated on the stack (<idStructure> is
the only <idType> allowed with the IS keyword.) See the VOSTRUCT
entry in this guide for more information on data structure memory

© 2015- 2019 XSharp BV

233 XSharp Bandol

allocation.

Description
LOCAL is a declaration statement that declares one or more variables or arrays as local
to the current routine (i.e., function, method, or procedure). Like other variable declaration
statements (such as FIELD and MEMVAR), you must place LOCAL statements before
any executable statements (including PRIVATE, PUBLIC, and PARAMETERS) in the
routine you are defining.
Local variable declarations hide all inherited private variables, visible public variables,
instance variables, global variables, and constants with the same name.
The search order for a variable name is as follows:
1. LOCALs, local parameters, MEMVARs, and FIELDs
2. SELF instance variables (i.e., without <idObject>: prefix in class methods)
3. GLOBALs and DEFINEs
A LOCAL statement that declares a variable name which is already declared within the
same routine (with FIELD, LOCAL, or MEMVAR) causes a compiler error.
Local variables are visible only within the current routine, and unlike private variables, are
not visible within invoked routines. If a routine is invoked recursively, each recursive
activation creates a new set of local variables.
Unless you specify the STATIC keyword, local variables are created automatically each
time the routine in which they were declared begins executing. They continue to exist and
retain their values until the declaring routine returns control to the routine that invoked it.
The STATIC keyword serves as a lifetime modifier for a local variable, preventing the
variable from being released from memory when the creating entity returns to its calling
routine.
Important! When an application containing static variable declarations is invoked, the
variables are created and initialized before the beginning of program execution. Thus,
initial values are assigned only once per application run, not each time the creator is
called.
For more information on variable declarations and scoping, refer to the "Variables,
Constants, and Declarations" chapter in the Programmer's Guide.

Notes
Local parameters: The FUNCTION, METHOD, and PROCEDURE statements allow you
to declare a list of local parameters enclosed in parentheses following the entity name.
For example:

FUNCTION <idFunction>(<idParamList>)

Exporting locals through code blocks: When you create a code block, you can access
local variables defined in the creating entity within the code block definition without passing
them as parameters (because local variables are visible to the code block). This, along
with the fact that you can pass a code block as a parameter, allows you to export local
variables. For example:

FUNCTION One() EXPORT LOCAL

LOCAL nVar := 10 AS INT, cbAdd AS CODEBLOCK
cbAdd := {|nValue| nValue + nVar}
? NextFunc(cbAdd) // Result: 210

© 2015- 2019 XSharp BV

 X# Documentation 234

FUNCTION NextFunc(cbAddEmUp)
RETURN EVAL(cbAddEmUp, 200)

When the code block is evaluated in NextFunc(), nVar, which is local to function One(),
becomes visible even though it is not passed directly as a parameter.
Macro expressions: You cannot refer to local variables within macro variables and
expressions. If you refer to a local variable within a macro variable, a private or public
variable with the same name will be referenced instead. If no such variable exists, a
runtime error will be raised.
Type of a local variable: Since Type() uses the macro operator (&) to evaluate its
argument, you cannot use it to determine the type of a local variable or an expression
containing a local variable reference. You can, however, use ValType() which evaluates its
argument and returns the type of the return value.
Memory files: You cannot SAVE or RESTORE local variables.

Examples
The following example declares two local arrays and two local variables:

LOCAL aArray1[20, 10], aArray2[20][10], var1, var2

This example declares two local variables with initializers. The first is initialized to a date
value and the second to an array:

LOCAL dWhen := TODAY()

LOCAL aVegies := {"Tomato", "Chickadee", "Butterbean"}

In this example, the variable x and the dimensioned array z are typed as INT, while the
variables cName and cAddr are typed as STRING:

LOCAL x, DIM z[100] AS INT, cName, cAddr AS STRING

The next example declares static variables both with and without initializers:

STATIC LOCAL aArray1[20, 10], aArray2[20][10]

STATIC LOCAL cVar, cVar2
STATIC LOCAL cString := "my string", var
STATIC LOCAL aArray := {1, 2, 3}

Here a static variable is manipulated within a function. In this example, a count variable
increments itself each time the function is called:

FUNCTION MyCounter(nNewValue)
// Initial value assigned once
STATIC LOCAL nCounter := 0
IF nNewValue != NIL
// New value for nCounter

© 2015- 2019 XSharp BV

 235 XSharp Bandol

nCounter := nNewValue
ELSE
// Increment nCounter
++nCounter
ENDIF
RETURN nCounter

The following code initializes a local with a Generic List and lets the compiler detect the
type of the local variable

VAR aList := List<STRING>{}

See Also
FIELD, FUNCTION, DEFINE, GLOBAL, MEMVAR, METHOD, PROCEDURE, STATIC

1.7.1.1.4.20 LOOP

The Loop statement jumps back to the beginning of the current DO WHILE, FOR NEXT,
FOREACH NEXT or REPEAT UNTIL block

1.7.1.1.4.21 MEMVAR

The MEMVAR statement is NOT available in the Core and Vulcan dialects and will only
be enabled if the -memvar commandline option is specified.

Purpose
Declare one or more memory variable names to be used by the current routine.

Syntax
MEMVAR <idMemvarList>

Arguments
<idMemvarList> A list of public and private variable names to declare to the compiler.

Description
When you use the MEMVAR statement to declare variables, unaliased references to
variables in <idMemvarList> are treated as if they were preceded by the special memory
variable alias
(_MEMVAR->).
Like other variable declaration statements (such as LOCAL and FIELD), you must place
MEMVAR statements before any executable statements (including PRIVATE, PUBLIC,
and PARAMETERS) in the routine you are defining. The MEMVAR statement has no effect
on the macro operator, which always assumes memory variables.

© 2015- 2019 XSharp BV

 X# Documentation 236

The MEMVAR statement neither creates the variables nor verifies their existence. Its
primary purpose is to ensure correct references to variables that are known to exist at
runtime. Attempting to access variables before they are created will raise a runtime error.

Examples
This example demonstrates the relationship between a private and field variable with the
same name. The private variable is declared with the MEMVAR statement:

FUNCTION Example()
MEMVAR Amount, Address
PRIVATE Amount := 100
USE customer NEW
? Amount // Refers to Amount private variable
? Customer->Amount
// Refers to Amount field variable

See Also
FIELD, LOCAL, PARAMETERS, PRIVATE, PUBLIC, STATIC

1.7.1.1.4.22 NOP

nop : NOP eos

1.7.1.1.4.23 PARAMETERS

The PARAMETERS statement is NOT available in the Core and Vulcan dialects and will
only be enabled if the -memvar commandline option is specified.

Purpose
Create private variables to receive passed values or references.

Syntax
PARAMETERS <idPrivateList>

Arguments
<idPrivateList> One or more parameter variables separated by commas. These
variables are used to receive arguments that you pass when you call
the routine.

Description
When a PARAMETERS statement executes, all variables in the parameter list are created
as private variables and all public or private variables with the same names are hidden
until the current procedure or function terminates. A PARAMETERS statement is an
executable statement and can, therefore, occur anywhere in a procedure or function.

© 2015- 2019 XSharp BV

 237 XSharp Bandol

Parameters can also be declared as local variables if specified as a part of the

PROCEDURE or FUNCTION declaration statement (see the example). Parameters
specified in this way are referred to as formal parameters. Note that you cannot specify
both formal parameters and a PARAMETERS statement within a procedure or function
definition.
Attempting to do this results in a compiler error.
The number of receiving variables does not have to match the number of arguments
passed by the calling routine. If you specify more arguments than parameters, the extra
arguments are ignored. If you specify fewer arguments than parameters, the extra
parameters are created with a NIL value. If you skip an argument, the corresponding
parameter is initialized to NIL.
The PCount() function returns the position of the last argument passed in the list of
arguments. This is different than the number of parameters passed, since it includes
skipped parameters.
For more information on passing parameters, refer to the "Functions and Procedures"
chapter in the Programmer's Guide.

Examples
This function receives values passed into private parameters with a PARAMETERS
statement:

FUNCTION MyFunc()
PARAMETERS cOne, cTwo, cThree
? cOne, cTwo, cThree

The next example is similar, but receives values passed into local variables, by declaring
the parameter variables within the FUNCTION declaration:

FUNCTION MyFunc(cOne, cTwo, cThree)

? cOne, cTwo, cThree

1.7.1.1.4.24 PRIVATE

The PRIVATE statement is NOT available in the Core and Vulcan dialects and will only be
enabled if the -memvar commandline option is specified.

Purpose
Create variables and arrays visible within current and invoked routines.

Syntax
PRIVATE <idVar> [:= <uValue>][, ...]

Arguments
<idVar> A valid identifier name for the private variable to create.
<uValue> The initial value to assign to the variable. If not specified, the variable is
initialized to NIL.

© 2015- 2019 XSharp BV

 X# Documentation 238

Description
When you create a private variable or array, existing and visible private and public
variables of the same name are hidden until the current routine terminates or the private
variable is explicitly released.
Attempting to specify a private variable that conflicts with a visible local variable is
recognized by the compiler as an error. Private variables with the same name as a
GLOBAL or DEFINE will not be recognized by the compiler.
In class methods, if the private variable conflicts with an instance variables, you should
use the _MEMVAR-> prefix to access the private variable and the SELF: prefix to access
the instance variable to make sure that the right variable is used within a method if there is
a name conflict.
In addition to the PRIVATE statement, you can create private variables by:
· Assigning to a variable that does not exist or is not visible will create a private variable
(only possible if you compile with the -undeclared command line option)
· Receiving parameters using the PARAMETERS statement
Private variables are dynamically scoped. They exist until the creating routine returns to its
caller or until explicitly released with CLEAR ALL, or CLEAR MEMORY.

Notes
Compatibility: The ALL, LIKE, and EXCEPT clauses of the PRIVATE statement supported
by other Xbase dialects are not supported.

Examples
The following example creates two PRIVATE arrays and three other PRIVATE variables:

PRIVATE aArray1[10], aArray2[20], var1, var2, var3

The next example creates a multi-dimensional private array using each element
addressing convention:

PRIVATE aArray[10][10][10], aArray2[10, 10, 10]

This example uses PRIVATE statements to create and initialize arrays and variables:

PRIVATE aArray := { 1, 2, 3, 4 }, ;
aArray2 := ArrayNew(12, 24)
PRIVATE cChar := Space(10), cColor := SetColor()

See Also
LOCAL, MEMVAR, PARAMETERS, PUBLIC

© 2015- 2019 XSharp BV

 239 XSharp Bandol

1.7.1.1.4.25 PUBLIC

The PUBLIC statement is NOT available in the Core and Vulcan dialects and will only be
enabled if the -memvar commandline option is specified.

Purpose
Creates variables and arrays visible to all routines in an application.

Syntax
PUBLIC <idVar> [:= <uValue>] [, ...]

Arguments
<idVar> A valid identifier name for the public variable to create.
<uValue> The initial value to assign to the variable. This can be any valid
expression. If <uValue> is not specified, the variable is initialized to
FALSE

Description
Any declared variables, such as LOCALs, with the same names as existing public or
private variables temporarily hide the public or private variables until the overriding
variables are released or are no longer visible.
An attempt to create a public variable with the same name as an existing and visible
private variable is simply ignored; however the assignment portion of the PUBLIC
statement is not ignored. For example, the following lines of code change the value of the
variable x but do not change its scope from private to public:

PRIVATE x := 1000
...
PUBLIC x := "New value for x"
? x // Result: "New value for x"

The explanation for this behavior is that, internally, the PUBLIC statement and the
assignment are treated as separate statements. Thus, this code would be treated as
follows:

PRIVATE x := 1000
...
PUBLIC x
x := "New value for x"
? x // Result: "New value for x"

The PUBLIC statement is ignored, but the assignment statement is executed, changing
the value of the private variable x.
This behavior has an interesting repercussion when you declare a public array using a
variable name that already exists as private. For example:

PRIVATE x := 1000
...

© 2015- 2019 XSharp BV

 X# Documentation 240

PUBLIC x[10]
? x[1] // Result: NIL

In this case, the PUBLIC statement is also treated as two separate statements:

PRIVATE x := 1000
...
PUBLIC x
x := ArrayNew(10)
? x[1] // Result: NIL

Again, the PUBLIC statement is ignored, and the assignment changes x from a private
numeric variable to a private reference to a ten element array.
Attempting to specify a public variable that conflicts with a visible declared variable (for
example, LOCAL, GLOBAL, or DEFINE) of the same name is not recognized by the
compiler as an error because PUBLIC is not a compiler declaration statement. Instead,
the declared variable will hide the public variable at runtime. This means that you will not
be able to access the public variable at all until the declared variable is released.
In class methods, instance variables (with the exception of access/assign variables) are
always more visible than public variables of the same name. Use the _MEMVAR-> alias to
access a public variable within a method if there is a name conflict. For access/assign
variables, use the SELF: prefix to override a name conflict with a public variable.
Public variables are dynamically scoped. They exist for the duration of the application or
until explicitly released with CLEAR ALL or CLEAR MEMORY.

Notes
PUBLIC Clipper: To be compatible with Visual Objects the special public variable, Clipper,
is initialized to TRUE when created with PUBLIC.
Examples
This example creates two PUBLIC arrays and one PUBLIC variable:

PUBLIC aArray1[10, 10], var2

PUBLIC aArray2[20][10]

The following PUBLIC statements create variables and initialize them with values:

PUBLIC cString := Space(10), cColor := SetColor()

PUBLIC aArray := {1, 2, 3}, ;
aArray2 := ArrayNew(12, 24)

See Also
GLOBAL, MEMVAR, PARAMETERS, PRIVATE

© 2015- 2019 XSharp BV

 241 XSharp Bandol

1.7.1.1.4.26 REPEAT ... UNTIL

repeatstmt : REPEAT eos

statementBlock
UNTIL expression eos

1.7.1.1.4.27 RETURN

Purpose
Terminate a routine by returning control to the calling routine or operating system if
executed from the Start() routine.

Syntax
RETURN [<uValue>]

Arguments
<uValue> May be specified in a function or method definition to designate its
return value. Procedure definitions do not allow <uValue> as part of the
RETURN statement. See the FUNCTION and METHOD entries in this
guide for information about default return values if <uValue> is not
specified.

Description
All private variables created and local variables declared in the current routine are
released from memory when control returns.

Examples
These examples illustrate the general form of the RETURN statement in a procedure and
in a function:

PROCEDURE <idProcedure>()
<Statements>...
RETURN

FUNCTION <idFunction>()
<Statements>...
RETURN <uValue>

The next example returns an array, created in a function, to a calling routine:

FUNCTION PassArrayBack()
LOCAL aArray[10][10] AS ARRAY
aArray[1][1] = "myString"
RETURN aArray

© 2015- 2019 XSharp BV

 X# Documentation 242

See Also
BEGIN SEQUENCE, FUNCTION, LOCAL, PRIVATE, PROCEDURE, PUBLIC, QUIT

1.7.1.1.4.28 Statement Block

A statement block is a list of zero or more statements that can appear on many places in
the language

1.7.1.1.4.29 SWITCH

switchstmt : (BEGIN|DO)? SWITCH expression eos

(CASE constantexpression eos
statementBlock ) *
(OTHERWISE) eos
statementBlock )?
END SWITCH? garbage? eos

1.7.1.1.4.30 THROW

throwstmt : THROW expression? eos

1.7.1.1.4.31 TRY ... CATCH ... FINALLY

trystmt : TRY eos

statementBlock
(CATCH identifier? AS datatype? eos
statementBlock ) *
(FINALLY eos
statementBlock)?
END TRY? garbage? eos

1.7.1.1.4.32 YIELD EXIT

yieldexitstmt : YIELD (EXIT|BREAK) eos

© 2015- 2019 XSharp BV

 243 XSharp Bandol

1.7.1.1.4.33 YIELD RETURN

yieldstmt : YIELD RETURN (expression)? eos

;

1.7.1.1.4.34 STATIC

Purpose
Declare and initialize static variables and arrays.

Syntax
STATIC [LOCAL] <idVar> [:= <uValue>] [, ...] [AS | IS <idType>] [, ...]
STATIC [LOCAL] DIM <ArraySpec> [, ...] AS | IS <idType> [, ...]
STATIC [LOCAL] <ArraySpec> [, ...] [AS ARRAY] [, ...]
Note: The STATIC statement is shown using several syntax diagrams for convenience
only. You can declare variables, dynamic arrays, and dimensioned arrays using a single
STATIC statement if each definition is separated by a comma.

Description
The STATIC keyword serves as a lifetime modifier for variables declared with the LOCAL
statement, preventing them from being released from memory when the creating entity
returns to its calling routine. It is listed here as a separate entry because, the LOCAL
keyword being optional, STATIC can stand alone in a routine as a variable declaration
statement. Refer to the LOCAL statement for a description and notes concerning static
variable declarations.

See Also
LOCAL

1.7.1.1.5 Literals

The X# language knows the following literal types

Keyword Description
Char Literals
Date Literals
Logic Literals
Macros
NULL Literals
Numeric Literals
String Literals

© 2015- 2019 XSharp BV

 X# Documentation 244

Keyword Description
Symbol Literals

1.7.1.1.5.1 Char Literals

There are different notations for a char literal depending on the dialect selected.
In the many dialects the single quotes are string delimiters and therefore the 'c' prefix is
needed for character literals.
Only in the Core and Vulcan dialects single quotes are always reserved for character
literals

Literal VO, XPP, FoxPro & Vulcan & Core

Harbour
c'<char>' or c"<char>" Char literal* Char literal*
'<char>' String literal Char literal*

The <char> literals in the table that are marked with an asterisk (*) may contain a special
escape code

Character Description
Character that does NOT start with a Normal character
backslash
\\ Backslash
\" Double quote
\' Single quote
\0 0 character
\a Alert
\b Backspace
\f Form feed
\n Newline
\r Line feed
\t Tab
\v Vertical tab
\x HEXDIGIT(1-4) Hex number of character. 1-4 hex digits
\u HEXGDIGIT (4 or 8) Unicode number of character. 4 or 8 hex
digits

© 2015- 2019 XSharp BV

 245 XSharp Bandol

1.7.1.1.5.2 String Literals

There are a couple of different string types inside X#. For normal strings the notation can
be different for different dialects:

Literal VO & Harbour Vulcan & Core

'<char>' String literal Char literal*
'<char>...<char>' String literal Not Supported
"<char>...<char>" String literal String literal
e"<char>...<char>" Extended string literal* Extended string literal*
i"<char>.. Interpolated string literal Interpolated string literal
<char>{expression}"
ei"<char>.. Extended interpolated string Extended interpolated string
<char>{expression}" or literal* literal*
ie"<char>..
<char>{expression}"

The <char> literals in the table that are marked with an asterisk (*) may contain a special
escape code

Character Description
Character that does NOT start with a Normal character
backslash
\\ Backslash
\" Double quote
\' Single quote
\0 0 character
\a Alert
\b Backspace
\f Form feed
\n Newline
\r Line feed
\t Tab
\v Vertical tab
\x HEXDIGIT(1-4) Hex number of character. 1-4 hex digits
\u HEXGDIGIT (4 or 8) Unicode number of character. 4 or 8 hex
digits

© 2015- 2019 XSharp BV

 X# Documentation 246

1.7.1.1.5.3 Date Literals

Date literals are formatted

YYYY.MM.DD

or alternatively
{^YYYY-MM-DD}

DateTime Literals can be constructed with the followin syntax

{^YYYY-MM-DD HH:MM:SS}.

Examples:

2000.01.01
2012.02.29
2015.09.25
// foxpro date and datetime literals
{^2019.02.28}
{^2020.02.29 23:59:59}

Date and DateTime literals are supported in all dialects. In the Core dialect both date and
datetime literals will be translated to a DateTime value. In the other dialects the Date
literals are translated to a Date value.
Of course you can also use runtime functions to construct a literal, such as
STOD("20150925") or ConDate(2019,9,25) but a literal is more efficient.

1.7.1.1.5.4 Logic Literals

X# uses the following Logical literals.

Value Description
TRUE or .T. or .Y. Logical TRUE
FALSE or .F. or .N. Logical FALSE

1.7.1.1.5.5 Null Literals

X# uses the following NULL literals. They indicate the absense of a value.
Some of these literals require the runtime.

Value Description Requires Runtime

© 2015- 2019 XSharp BV

 247 XSharp Bandol

NULL "Multi purpose" NULL. Can N

be used for OBJECT type
and Pointer types.
NULL_ARRAY Null reference to the xBase Y
ARRAY type
NULL_CODEBLOCK Null reference to the xBase Y
CODEBLOCK type
NULL_DATE Empty date (0000-00-00) Y
NULL_OBJECT Null reference to an N
OBJECT value
NULL_PSZ Null PSZ value Y
NULL_PTR Null PTR value N
NULL_STRING Null reference to a string. N
When the compiler
option /vo2 is used then this
will become the equivalent
of String.Empty
NULL_SYMBOL NULL reference to the Y
xBase SYMBOL type
.NULL. This FoxPro literal null is N
translated to a NULL
reference

1.7.1.1.5.6 Numeric Literals

The X# language knows the following numeric literal types

Keyword Description
Integer Literals
Real Liteals

© 2015- 2019 XSharp BV

 X# Documentation 248

Literal INT values may be specified in decimal, hexadecimal or binary notation:

12345
0x1234ABCD
0b010010101

Integer literals may have one of the following suffixes:

Suffix
L or l Signed 32 bits integer
U or u Unsigned integer

Single or double precision literals may be used to store numeric values in your code.

123.456
123.0
0.123
.123
123.456e+7
123.456e-7

Real literals may have one of the following suffixes:

Suffix
S or s Single precision (REAL4)
D or d Double precision (REAL8)
M or m Decimal

Floating point literals without suffix are stored as REAL8, unless you have specified
the /vo14 compiler option, in which case they are stored as FLOAT literals.

1.7.1.1.5.7 Symbol Literals

Symbol literals consist of the '#' character followed by one of more alphanumeric
characters

#XSharp
#AnExample

Even though the examples above are written in mixed case, the compiler will treat them
as all uppercase.
Symbol literals are compiled only once by the X# compiler for performance reasons.
Each .Net assembly created by the X# compiler will have a special, compiler generated,

© 2015- 2019 XSharp BV

 249 XSharp Bandol

class that contains all the literal symbols found in that assembly.
These literals are initialized at startup and stored in the symbol table in the runtime.

1.7.1.1.6 NameSpaces

Enter topic text here.

1.7.1.1.6.1 USING

#USING <NamespaceName>
USING <NamespaceName>
USING STATIC <StaticClassname>

1.7.1.1.6.2 BEGIN NAMESPACE

The syntax rule for namespaces is:

namespace : BEGIN NAMESPACE <Namespace> EOS

(entity)*
END NAMESPACE EOS
;

1.7.1.1.7 Identifiers

Identifiers in X# appear on many places in the language. They consist of a character

followed by one or more characters, numbers or digits. The lexer definition for identifiers is
below. As you can see we also allow 'special characters' and 'unicode characters' , but in
general that is not recommended.

New keywords that are introduced in Vulcan and X# (see the keyword table) can also be
used as Identifier
When an identifier must be used that has the same value as a keyword, then you can
prefix the identifier with a double @@ sign, like in the following example.
This is not recommended. But it can happen that code in an external DLL has properties
or method names that are keywords in X#. In that case using the @@ prefix can work too.

LOCAL @@Class as STRING

LOCAL @@Local as LOGIC

ID : IDStartChar IDChar*
;

fragment IDStartChar: 'A'..'Z' | 'a'..'z'

| '_'

© 2015- 2019 XSharp BV

 X# Documentation 250

| '\u00C0'..'\u00D6'
| '\u00D8'..'\u00F6'
| '\u00F8'..'\u02FF'
| '\u0370'..'\u037D'
| '\u037F'..'\u1FFF'
| '\u200C'..'\u200D'
;

fragment IDChar : IDStartChar

| '0'..'9'
| '\u00B7'
| '\u0300'..'\u036F'
| '\u203F'..'\u2040'
;

1.7.1.1.8 Calling Conventions

CLIPPER
STRICT
PASCAL
FASTCALL
THISCALL
ASPEN
CALLBACK
_WINCALL

1.7.1.1.9 Comments

//
&&
/* */

1.7.1.1.10 Compiler Macros

The following defines can be used in your code and will be replaced by the compiler with a
literal value:
Name Type Value
__ARRAYBASE__ Integer 0 or 1 depending on the /az
compiler option
__CLR2__ String Literal __CLR2__ (only for
compatibility with Vulcan, x#
does not implement the /clr
compiler option). See
comment below.
__CLR4__ String Literal __CLR4__ (only for
compatibility with Vulcan, x#
does not implement the /clr

© 2015- 2019 XSharp BV

251 XSharp Bandol

compiler option). See

comment below.
__CLRVERSION__ String Literal "2" or "4"depending on the
version. (only for
compatibility with Vulcan, x#
does not implement the /clr
compiler option). See
comment below.
__DATE__ String Literal Current date in YYYYMMDD
format
__DATETIME__ String Literal Current date/time in format
from regional settings
__DIALECT__ String Name of the current dialect
__DIALECT_CORE__ Logical Defined with TRUE when
Core dialect is selected
__DIALECT_FOXPRO__ Logical Defined with TRUE when
FoxPro dialect is selected
__DIALECT_HARBOUR__ Logical Defined with TRUE when
Harbour dialect is selected
__DIALECT_VO__ Logical Defined with TRUE when
VO dialect is selected
__DIALECT_VULCAN__ Logical Defined with TRUE when
Vulcan dialect is selected
__DIALECT_XBASEPP__ Logical Defined with TRUE when
XBase++ dialect is selected
__DEBUG__ Logical Literal TRUE when compiling in
debug mode. Undefined in
Release mode
__ENTITY__ String Literal Name of current entity
__FILE__ String Literal Current source file name
__FUNCTION__ String Literal Current function/method
name without class prefix
and in original case
__FUNCTIONS__ String Literal Returns the name of the
current Functions class
__HARBOUR__ Logic literal TRUE when the Harbour
dialect is selected.
Otherwise not defined.
__LINE__ String Literal Current source line number
__MODULE__ String Literal Current source file name
__SIG__ String Literal Signature of current entity

© 2015- 2019 XSharp BV

 X# Documentation 252

__SRCLOC__ String Literal Filename and line number in

the source
__SYSDIR__ String Literal Systemdir (on developers
machine!)
__TIME__ String Literal Compile time in HH:mm:ss
format
__UTCTIME__ String Literal UTC Compile time in
HH:mm:ss format
__VERSION__ String Literal Version of the compiler
__VO__ Logic literal TRUE when the VO dialect
is selected. Otherwise not
defined.
__VO1__ , __VO2__ ... Logical Current value of the
__VO16__ matching VO compatibility
compiler option
__VULCAN__ Logic literal TRUE when the Vulcan
dialect is selected.
Otherwise not defined.
__WINDIR__ String Literal Windows dir (on developers
machine!)
__WINDRIVE__ String Literal Windows drive (on
developers machine!)
__XPP__ Logic literal TRUE when the XBase++
dialect is selected.
Otherwise not defined.
__XSHARP__ Logical Literal Always TRUE
__XSHARP_RT__ Logical Literal TRUE when compiling
against the X# runtime. Not
defined otherwise.

Note
The CLR2 and CLR4 version is determined by the X# compiler by looking at the version of
either system.dll or mscorlib.dll

1.7.1.1.11 Pseudo Functions

The following pseudo functions are supported by the X# compiler

Function Description
PCOUNT() This pseudo function is only available in the
VO/Vulcan dialect and only in methods or
functions with a CLIPPER calling
convention.

© 2015- 2019 XSharp BV

253 XSharp Bandol

It returns the number of argument passed

to the function. The function does not
expect and does not allow any arguments.
ARGCOUNT() This pseudo function returns the number of
arguments defined for the current method
or function.
_GETMPARAM() and _GETFPARAM() These pseudo functions are only available
in the VO/Vulcan dialect and only in
methods or functions with a CLIPPER
calling convention.
You can use them to retrieve a function
parameter by position. You must pass a
numeric expression to these functions. If
you pass a number that is larger than the
actual number of parameters at runtime
then you will get an array access
exception.
String2Psz() and Cast2Psz() These pseudo functions are used in the
VO/Vulcan dialect to convert DotNet strings
to unmanaged Ansi PSZ strings. Not only is
a PSZ created, but the functions also
change the code generation and set up
code to clear the allocated PSZ variable on
exit of the function in which they are
created.
ALTD() This function will insert a call to
System.Diagnostics.Debugger.Break
inside a check to see if the debugger is
attached
(System.Diagnostics.Debugger.IsAttached)
_GetInst() This function will return the module handle
for the current module. Behind the scenes
this is translated to
System.Runtime.InteropServices.Marshal.
GetHINSTANCE(TypeOf(FunctionsClass):
Module)
PCALL() and CCALL() The methods are used to call an API
function for a strongly typed PTR.
The function expects a first parameter of
type PTR and the other parameters must
match the parameters defined in the
function to which the typed PTR points
This is not yet supported in the current
compiler version
PCallNative<Type>() and The methods are used to call an API
CCallNative<Type>() function for an untyped PTR
The function expects a generic type
parameter which indicates the return type

© 2015- 2019 XSharp BV

 X# Documentation 254

and a first parameter of type PTR. Other

parameters are allowed and must not point
to managed memory.
This is not yet supported in the current
compiler version
_ARGS() This pseudo function returns is replaced by
the compiler to a reference to the
generated array of parameters for
functions/methods with clipper calling
convention
SLen() This function is translated by the compiler
to a call of the Length property of the string,
with a built-in check for NULL.

1.7.1.1.12 Helpers

The grammar contains several helper tokens. These are listed below

EOS <END OF STATEMENT> CRLF token or ';' token that indicates end of
statement

eos : EOS+ One or more EOS tokens

;

garbage : (~EOS)+ All tokens until a EOS token (used to

ignore "garbage" after NEXT, ENDIF etc.
; This is NOT supported in the Core dialect
!

1.7.1.2 X# Expressions
Expressions are an important element of the language. There are many types of
expressions. The expression rule in the compiler is the biggest rule
The table below lists the various expression types in the order they are recognized by the
compiler. Some expression types are covered in a separate topic.
As you can see most expression types are recursive. They contain one or more
references to sub expressions

Expressions

Expression type Syntax VO VN X#

expression (DOT|
Member Access Y
COLON) identifier

© 2015- 2019 XSharp BV

255 XSharp Bandol

Expression type Syntax VO VN X#

expression LPAREN
Method Call argumentlist? Y
RPAREN
expression LBRKT
Arrayelement Access Y
argumentlist RBRKT
expression ?
Conditional Access Y
boundexpression
LPAREN datatype
Typecast Y
RPAREN
Postfix expression (++ | --) Y
Await AWAIT expression Y
(+|-|~|@|++|--)
Prefix Y
expression
Typecheck expression IS datatype Y
expresion ASTYPE
As Typecheck Y
datatype
expression (^|**)
Powerof Y
expression
expression (*|/|%)
MulDiv Y
expression
expression (+|-)
PlusMinus Y
expression
expression <<
LShift Y
expression
expression >>
RShift Y
expression
expression
OPERATOR
expression,
Comparison Y
where OPERATOR is
<,<=, >, >=, =, ==,
$, !=, <>, #
expression &
Bitwise And Y
expression
expression ~
Bitwise XOR Y
expression

© 2015- 2019 XSharp BV

 X# Documentation 256

Expression type Syntax VO VN X#

expression |
Bitwise OR Y
expression
Not Expression (.NOT. | !) expression Y
Logical AND expression (.AND.|&&)
Y Y
expression expression
expression (.OR. | ||)
Logical OR expression Y Y
expression
expression DEFAULT
Default expression Y
expression
expression
ASSIGN_OP
expression
Assignment
where ASSIGN_OP is Y
expression
:=, +=, -=, *=, ^=, /=, %
=, &=, |=, <<=, >>=,
~=
Primary expression See other rule

1.7.1.2.1 Bound Expressions

Bound expressions are expressions that access properties or members from objects or
structures

Expression type Syntax VO VN X#

boundexpression
Bound Member Access (DOT|COLON) Y
simpleName
boundexpression
Bound Method Call LPAREN argumentlist? Y
RPAREN

© 2015- 2019 XSharp BV

 257 XSharp Bandol

Expression type Syntax VO VN X#

boundexpression
Bound Array Access LBRKT argumentlist Y
RBRKT
Bound Conditional expression QMARK
Y
Access boundexpression
(DOT|COLON)
Bind Member Access Y
simpleName
LBRKT argumentlist
Bind Array Access Y
RBRKT

1.7.1.2.2 Primary Expressions

Primary Expressions are the simplest building blocks in the expression rule in X#

Primary Expression type Syntax VO VN X#

Self SELF Y
Super SUPER Y
LiteralArray {......} Y
Anonymous Type CLASS { .... }
CodeBlock Y
LINQ query Y
datatype LCURLY
expression COMMA, @
DelegateConstructor call Y
Identifier LPAREN
RPAREN RCURLY
datatype LCURLY
Constructor call with
argumentlist
parameters and optional Y Y
RCURLY( LCURLY
initializer
initializer RCURLY) ?
Constructor call without datatype LCURLY
parameters and with RCURLY (LCURLY Y Y
optional initializer initializer RCURLY) ?
CHECKED LPAREN
Checked Y
expression RPAREN

© 2015- 2019 XSharp BV

 X# Documentation 258

Primary Expression type Syntax VO VN X#

UNCHECKED LPAREN
Unchecked Y
expression RPAREN
(_typeof | TYPEOF)
Typeof LPAREN expression Y Y
RPAREN
(_sizeof | SIZEOF)
Sizeof LPAREN expression Y Y
RPAREN
(NAMEOF) LPAREN
Nameof Y
identifier RPAREN
DEFAULT LPAREN
Default Y
expression RPAREN
Name identifier Y
nativetype LPAREN
Conversion Y
expression RPAREN
xbasetype LPAREN
XBase Conversion Y
expression RPAREN
datatype LPAREN _CAST
VOCast COMMA exprsssion Y
RPAREN
PTR LPAREN datatype
VoCastPtr COMMA expression Y
RPAREN
VOTypeName typeName Y
(IIF|IF) LPAREN
expression COMMA
IIF expression Y
expression COMMA
expression RPAREN
_AND LPAREN
VOAnd Y
expressionlist RPAREN
_OR LPAREN
VOOr Y
expressionlist RPAREN
FIELD -> identifier
AliasedField Y
| identifier -> identifier
FIELD -> expression
Aliased Expression Y
| expression -> expression
AMPERSAND LPAREN
MacroExpr Y
expression RPAREN
MacroVar AMPERSAND identifier Y

© 2015- 2019 XSharp BV

 259 XSharp Bandol

Primary Expression type Syntax VO VN X#

LPAREN expression
Parenthesized Y
RPAREN
ArgList _ARGLIST Y

1.7.1.2.3 Codeblocks

Codeblocks are an important part of the X# language.

Traditionally the codeblock looked like

codeblock : LCURLY PIPE codeblockParamList? PIPE expression

RCURLY
;
codeblockParamList : identifier (COMMA identifier)*
;

For example

{|a,b| a*b}

X# has extended the Codeblock rule. We now not only accept a single expression, but
also a statement list and an expressionlist:

codeblock : LCURLY PIPE codeblockParamList? PIPE

( expression
| eos statementblock
| codeblockExpressionList )
RCURLY
;

codeblockExprList: (expression? COMMA)+ expression // The last

expression is the return value of the block
;

Examples of this are

{|a,b| a:= Sqrt(a), a*b}

{|a,b|

© 2015- 2019 XSharp BV

 X# Documentation 260

? a
? b
}

The second example can be seen as an anonymous method with 2 parameters

1.7.1.2.4 LINQ Expressions

The LINQ expression rule is:

linqquery : fromClause queryBody

;

fromClause : FROM identifier (AS typeName)? IN expression

;

queryBody : (queryBodyClause)* selectOrGroupclause

(queryContinuation)?
;

queryBodyClause : fromClause

| LET identifier ASSIGN_OP expression

| WHERE expression

| JOIN identifier (AS typeName)? IN expression ON

expression EQUALS expression joinIntoClause?
| ORDERBY ordering (COMMA ordering)*

joinIntoClause : INTO identifier

;

ordering : expression (ASCENDING|DESCENDING)?

;

selectOrGroupclause : SELECT expression

| GROUP expression BY expression
;

queryContinuation : INTO identifier queryBody

An example of a LINQ Query

VAR oAll := FROM D IN oDev ;

JOIN C IN oC ON D:Country EQUALS C:Name ;
ORDERBY D:LastName ;
SELECT CLASS {D:Name, D:Country, C:Region}

In this example you will see

© 2015- 2019 XSharp BV

 261 XSharp Bandol

fromclause: FROM D in oDev

querybody 1: JOIN C IN oC ON D:Country EQUALS C:Name
querybody 2: ORDERBY D:LastName
selectOrGroupClause: SELECT CLASS {...}

Other examples can be found in the LINQ Example topic

1.7.1.2.5 Initializers

X# has added two types of initializers to the language: collection Initializers and Object
Initializers. The syntax for these is:

constructorcall : datatype LCURLY RCURLY initializer?

| datatype LCURLY parameterlist RCURLY
initializer?
;

initializer : objectinitializer
| collectioninitializer
;

objectinitializer : LCURLY (memberinitializer (COMMA

memberinitializer)*)? RCURLY
;

memberinitializer : Name=identifierName ASSIGN_OP

Expr=initializervalue
;

initializervalue : objectOrCollectioninitializer
| expression
;

collectioninitializer : LCURLY expression (COMMA expression)*

RCURLY
;

Note:
· The initializer which is also delimited by curly braces immediately follows the closing
curly brace of the constructor call
An example of an object initializer:

VAR oPerson := Person{}{FirstName := "John", LastName := "Smith"}

VAR oPerson := Person{"John", "Smith"} {Age := 35 }

An example of a collection initializer

© 2015- 2019 XSharp BV

 X# Documentation 262

oList := List<Int>{} {1,2,3,4,5}

And combined:

Var oPeople := List<Person> {} {;

Person{}{FirstName := "John",
LastName := "Smith"}, ;
Person{}{FirstName := "Jane",
LastName := "Doe"} ;
}

The LINQ example topic shows different initializers in action.

1.7.1.3 X# Operators
X# has many operators. These are
· Binary operators
· Assignment operators
· Logical operators
· Bitwise operators
· Relational operators
· Shift operators
· Unary operators
· Workarea operators

1.7.1.3.1 Binary

X# uses the following binary operators:

Operator Example Meaning

+ x+y addition
- x-y subtraction
* x*y multiplication
/ x/y division. If the operands are
integers, the result is an
integer truncated toward
zero (for example, -7 / 2 is -
3).
% x%y modulus. If the operands
are integers, this returns the
remainder of dividing x by y.
If q = x / y and r = x % y,
then x = q * y + r.
^ or ** x ^ y or x ** y power of. x ^ y returns x to
the power of y

© 2015- 2019 XSharp BV

263 XSharp Bandol

Binary operators and XBase types

The following XBase types support binary operators.

Type Operator Description

ARRAY none binary operators are not
supported for arrays
DATE + and - You can add and subtract a
numeric to a date, which is
the equivalent of adding
days.
You can subtract a date
from a date which will return
the number of days between
the dates
FLOAT all You can perform all binary
operations on FLOATs
when both operands are
numeric. The compiler will
automatically insert a
conversion from <any
numeric type> to FLOAT
when the right hand side of
the binary operator is not a
float
SYMBOL none binary operators are not
supported for arrays
STRING + and - The + operator will add 2
strings. The - operator will
add the RHS to the LHS and
move all trailing spaces of
the LHS to the end of the
resulting string. You can
also add STRING values
and SYMBOL values. The
SYMBOLs will automatically
be converted to strings
USUAL all You can use all binary
operators on USUALs. The
code in the runtime will
check to see if the 2 sides
are "compatible" and will
produce a runtime error
when the operation is not
available.

© 2015- 2019 XSharp BV

 X# Documentation 264

1.7.1.3.2 Assignment operators

X# uses the following Assignment operators:

Operator Example Meaning

:= x := y Store the value of the
second operand in the
object specified by the first
operand (simple
assignment).
= x=y Store the value of the
second operand in the
object specified by the first
operand (simple
assignment).
This is allowed in the VFP
dialect only ! In all other
dialects assigning a value
with a '=' operator will
generate a warning.
+= x += y Add the value of the second
operand to the value of the
first operand; store the
result in the object specified
by the first operand
-= x -= y Subtract the value of the
second operand from the
value of the first operand;
store the result in the object
specified by the first
operand.
/= x /= y Divide the value of the first
operand by the value of the
second operand; store the
result in the object specified
by the first operand
%= x %= y Take modulus of the first
operand specified by the
value of the second
operand; store the result in
the object specified by the
first operand.
*= x *= y Multiply the value of the first
operand by the value of the
second operand; store the
result in the object specified
by the first operand.

© 2015- 2019 XSharp BV

 265 XSharp Bandol

^= or **= x ^= y Calculate the exponent of

the first operand and the
second operand ; store the
result in the object specified
by the first operand.
Please note that in
languages such as C# the
^= operator performs a
Bitwise XOR
|= x |= y Obtain the bitwise inclusive
OR of the first and second
operands; store the result in
the object specified by the
first operand.
&= x &= y Obtain the bitwise AND of
the first and second
operands; store the result in
the object specified by the
first operand.
~= x ~= y Obtain the bitwise exclusive
OR of the first and second
operands; store the result in
the object specified by the
first operand.
<<= x <<= y Shift the value of the first
operand left the number of
bits specified by the value of
the second operand; store
the result in the object
specified by the first
operand.
>>= x >>= y Shift the value of the first
operand right the number of
bits specified by the value of
the second operand; store
the result in the object
specified by the first
operand.

Assignment operators and XBase types

See the topic about Binary operators to see which complex assignment operators are
supported.

1.7.1.3.3 Logical

X# uses the following Logical operators:

Operator Example Meaning

© 2015- 2019 XSharp BV

 X# Documentation 266

.AND. x .AND. y Returns TRUE when both

operands are TRUE,
otherwise FALSE
.OR. x .OR. y Returns TRUE with one or
both operands are TRUE.
Only when both operands
are FALSE then FALSE is
returned
.NOT. or ! .NOT. x Reverses TRUE and
FALSE.

1.7.1.3.4 Bitw ise

X# uses the following Bitwise (binary) operators. There are simple character versions of
these and also pseudo functions:

Operator Pseudo Function Example Meaning

| _OR(..) x | y, _OR(x,y) Returns the bitwise
OR of x and y
_OR() may have
more than 2
parameters.
~ _XOR(..) x ~ y, _XOR(x,y) Returns the bitwise
XOR of x and y
& _AND(..) x & y, _AND(x,y) Returns the bitwise
AND of x and y.
_AND() may have
more than 2
parameters.
~ _NOT(..) ~ x, _NOT(x) Returns the bitwise
NOT of x (aka one's
complement).
_NOT() can only
have one parameter

The result of a bitwise operation is best understood via ‘truth tables’. If two numbers can,
for instance, be defined by 4 bits (expressing numbers 0 up to 15 in decimal value) then,
when ‘Anding’ them, use the AND truth table for each bit in turn. If the values in decimal
are 5 and 1 then their bit representations are 0101 and 0001.

© 2015- 2019 XSharp BV

 267 XSharp Bandol

1.7.1.3.5 Relational

X# uses the following Logical operators:

Operator Example Meaning

< x<y less than (true if x is less
than y).
See below for string
comparisons
<= x <= y less than or equal to (true if
x is less than or equal to y).
See below for string
comparisons
> x>y greater than (true if x is
greater than y).
See below for string
comparisons
>= x >= y greater than or equals to
(true if x is greater than or
equal to y).
See below for string
comparisons
= x=y equality.
Note that there is a
difference between = and
== for strings only. See
below
== x == y exact equality.
Note that there is a
difference between = and
== for strings only. See
below
<>, #, != x <> y, x # y, x != y not equal
Note that for strings this
follows the same rules as
the single = operator.
$ x$y Is substring of. Returns true
if the first string is a
substring of the second
(case sensitive !)
IS x IS y Type compatibility. Returns
true if the evaluated left
operand can be cast to the
type specified in the right
operand (a static type).

© 2015- 2019 XSharp BV

 X# Documentation 268

ASTYPE x ASTYPE y Type conversion. Returns

the left operand cast to the
type specified by the right
operand (a static type), but
as returns null where (T)x
would throw an exception.

String comparisons
The '=' and '==' operators behave differently for strings, and the behavior of the single
equals also depends on a runtime setting.

If you call SetExact(FALSE) then ‘=’ equates the characters up to the length of the string
on the right-hand side of the operator ignoring the remaining characters on the left. This is
the default setting. If you call SetExact(TRUE) then = and == have the same meaning for
strings.
The <, <=, > and >= operators for strings have a behavior that depends on a compiler
option and a runtime setting. The -vo13 compiler option 'compatible string comparions'
tells the compiler that it needs to use a runtime function for string comparisons. The
behavior of this runtime function depends on the setting of SetCollation(). There are 4
possible values for SetCollation():
Setting Description
Clipper This setting will convert both strings to
OEM strings using the current DOS
codepage. After that the strings will be
compared using the string comparison /
weight tables that are defined with
SetNatDLL(). The default comparison uses
a wight based on the byte number. Other
comparisons available are for example
GERMAN, DUTCH, FRENCH, RUSSION,
SPANISH, SLOV852 etc.
This setting should be used if your
application needs to share files with
CLIPPER programs.
Windows This setting will convert both strings to
ANSI using the current ANSI codepage.
After that the strings will be compared
using the normal windows ANSI
CompareString() code. This setting should
be used when your application shares files
with VO programs
Unicode This setting will NOT convert strings and
will do a normal Unicode string comparison
using the String.Compare() method from
the .Net
Ordinal This setting will NOT convert strings and
will do a normal Ordinal string comparison
using the String.CompareOrdinal() method
from the .Net. This is the fastest.

© 2015- 2019 XSharp BV

 269 XSharp Bandol

The >= and <= operators for strings also take into account the setting for SetExact(). The
'equalness' of the 2 strings is determined by the same rules as the '=' operator.

1.7.1.3.6 Shift

X# uses the following shift operators:

Operator Example Meaning

>> x >> y shift bits right. If the left
operand is signed, then left
bits are filled with the sign
bit. If the left operand is
unsigned, then left bits are
filled with zero.
<< x << y shift bits left and fill with
zero on the right.

Note that shift operators are only supported on integral numeric types

1.7.1.3.7 Unary

X# uses the following unary operators:

Operator Example Meaning

+ +x returns the value of x.
- -x numeric negation.
++ (prefix) ++x prefix increment. Returns
the value of x after updating
the storage location with the
value of x that is one greater
(typically adds the integer
1).
-- (prefix) --x prefix decrement. Returns
the value of x after updating
the storage location with the
value of x that is one greater
(typically adds the integer
1).
~ ~x bitwise complement
++ (postfix) x++ postfix increment. Returns
the value of x and then
updates the storage location
with the value of x that is
one greater (typically adds
the integer 1).
-- (postfix) x-- postfix decrement. Returns
the value of x and then

© 2015- 2019 XSharp BV

 X# Documentation 270

updates the storage location

with the value of x that is
one less (typically subtracts
the integer 1).

Note that shift operators are only supported on integral numeric types

1.7.1.3.8 Workarea

X# uses the following Workarea operators:

Operator Example Meaning

-> Customer->LastName Field "LastName" in the
FIELD->FirstName "Customer" workarea
_FIELD->Salary Field "FirstName" in the
M->Name current workarea
A->City Field "Salary" in the current
workarea
The dynamic memory
variable "Name" (public or
private)
The field City in workarea 1.
Allowed single letter aliases
are A .. J.

Note that FIELD and _FIELD

are synonyms.
. Customer.LastName In the VFP dialect we also
support the DOT (".") syntax
for aliased operations.
Please note that this is
ambiguous because the
compiler cannot detect at
compile time if CUSTOMER
is a workarea or for example
a MEMVAR. If there is a local
variable with the name
CUSTOMER then this will
access the LASTNAME
property of the CUSTOMER
local variable.
In all other cases this will
produce code that looks for
either a CUSTOMER
workarea or memory variable
at runtime.
. M.Name In the VFP dialect we also
support the DOT (".") syntax
for memvar access. This is
also ambiguous because
NAME can be both a local

© 2015- 2019 XSharp BV

 271 XSharp Bandol

variable or a dynamic
memory variable
"NAME" (public or private).
However the compiler will be
able to detect the local
variable at compile time and
when this is not found then it
will access the dynamic
memory variable.

1.7.1.4 X# Preprocessor Directives

The XSharp preprocessor supports the following preprocessor directives

#command
#define
#else
#endif
#endregion
#ifdef
#ifndef
#include
#line
#region
#translate
#undef

1.7.1.4.1 #command and #xcommand

Specify a user-defined command or translation directive

Syntax

#command <matchPattern> => <resultPattern>

#xcommand <matchPattern> => <resultPattern>

Arguments
<matchPattern> is the pattern the input text should match.

<resultPattern> is the text produced if a portion of input text matches the

<matchPattern>.

The => symbol between <matchPattern> and <resultPattern> is, along with#command or
#translate, a literal part of the syntax that must be specified in a #command or #translate
directive. The symbol consists of an equal sign followed by a greater than symbol with no
intervening spaces. Do not confuse the symbol with the >= or the <= comparison
operators in the xBase language.

© 2015- 2019 XSharp BV

 X# Documentation 272

Description
#command and #translate are translation directives that define commands and
pseudofunctions. Each directive specifies a translation rule. The rule consists of two
portions: a match pattern and a result pattern.
The match pattern matches a command specified in the program (.prg) file and saves
portions of the command text (usually command arguments) for the result pattern to use.
The result pattern then defines what will be written to the result text and how it will be
written using the saved portions of the matching input text.

#command and #translate are similar, but differ in the circumstance under which their
match patterns match input text. A #command directive matches only if the input text is a
complete statement, while #translate matches input text that is not a complete statement.
#command defines a complete command and #translate defines clauses and
pseudofunctions that may not form a complete statement. In general, use #command for
most definitions and #translate for special cases.

#command and #translate are similar to but more powerful than the #define directive.
#define, generally, defines identifiers that control conditional compilation and manifest
constants for commonly used constant values such as SDK codes. Refer to any of the
header files in the INCLUDE directory for examples of manifest constants defined using
#define.

#command and #translate directives have the same scope as the #define directive. The
definition is valid only for the current program (.prg) file unless defined in Std.ch or the
header specified with the /U option on the compiler command line. If defined elsewhere,
the definition is valid from the line where it is specified to the end of the program file.
Unlike #define, a #translate or #command definition cannot be explicitly undefined. The
#undef directive has no effect on a #command or #translate definition.

As the preprocessor encounters each source line preprocessor, it scans for definitions in
the following order of precedence: #define, #translate, and #command. When there is a
match, the substitution is made to the result text and the entire line is reprocessed until
there are no matches for any of the three types of definitions. #command and #translate
rules are processed in stack-order (i.e., last in-first out, with the most recently specified
rule processed first).

In general, a command definition provides a way to specify an English language statement

that is, in fact, a complicated expression or function call, thereby improving the readability
of source code. You can use a command in place of an expression or function call to
impose order of keywords, required arguments, combinations of arguments that must be
specified together, and mutually exclusive arguments at compile time rather than at
runtime. This can be important since procedures and user-defined functions can now be
called with any number of arguments, forcing any argument checking to occur at runtime.
With command definitions, the preprocessor handles some of this.

When defining a command, there are several prerequisites to properly specifying the
command definition. Many preprocessor commands require more than one #command
directive because mutually exclusive clauses contain a keyword or argument. For
example, the @...GET command has mutually exclusive VALID and RANGE clauses and
is defined with a different #command rule to implement each clause.

This also occurs when a result pattern contains different expressions, functions, or

© 2015- 2019 XSharp BV

273 XSharp Bandol

parameter structures for different clauses specified for the same command (e.g., the
@...SAY command). In Std.ch, there is a #command rule for @...SAY specified with the
PICTURE clause and another for @...SAY specified without the PICTURE clause. Each
formulation of the command is translated into a different expression.

Because directives are processed in stack order, when defining more than one rule for a
command, place the most general case first, followed by the more specific ones. This
ensures that the proper rule will match the command specified in the program (.prg) file.

Match Pattern
The <matchPattern> portion of a translation directive is the pattern the input text must
match. A match pattern is made from one or more of the following components, which
the preprocessor tries to match against input text in a specific way:

· Literal values are actual characters that appear in the match pattern. These characters
must appear in the input text, exactly as specified to activate the translation directive.

· Words are keywords and valid identifiers that are compared according to the dBASE
convention (case-insensitive, first four letters mandatory, etc.). The match pattern must
start with a Word.

· #xcommand and #xtranslate can recognize keywords of more than four significant
letters.

· Match markers are label and optional symbols delimited by angle brackets (<>) that
provide a substitute (idMarker) to be used in the <resultPattern> and identify the clause
for which it is a substitute. Marker names are identifiers and must, therefore, follow the
xBase identifier naming conventions. In short, the name must start with an alphabetic or
underscore character, which may be followed by alphanumeric or underscore
characters.

This table describes all match marker forms:

Match Marker Name

<idMarker> Regular match marker
<idMarker,...> List match marker
<idMarker:word list> Restricted match marker
<*idMarker*> Wild match marker
<(idMarker)> Extended Expression match marker

· Regular match marker: Matches the next legal expression in the input text. The regular
match marker, a simple label, is the most general and, therefore, the most likely match
marker to use for a command argument. Because of its generality, it is used with the
regular result marker, all of the stringify result markers, and the blockify result marker.

· List match marker: Matches a comma-separated list of legal expressions. If no input

text matches the match marker, the specified marker name contains nothing. You must
take care in making list specifications because extra commas will cause unpredictable

© 2015- 2019 XSharp BV

 X# Documentation 274

and unexpected results.

The list match marker defines command clauses that have lists as arguments.
Typically these are FIELDS clauses or expression lists used by database commands.
When there is a match for a list match marker, the list is usually written to the result text
using either the normal or smart stringify result marker. Often, lists are written as literal
arrays by enclosing the result marker in curly ({ }) braces.

· Restricted match marker: Matches input text to one of the words in a comma-
separated list. If the input text does not match at least one of the words, the match fails
and the marker name contains nothing.

A restricted match marker is generally used with the logify result marker to write a
logical value into the result text. If there is a match for the restricted match marker, the
corresponding logify result marker writes true (.T.) to the result text; otherwise, it writes
false (.F.). This is particularly useful when defining optional clauses that consist of a
command keyword with no accompanying argument. Std.ch implements the REST
clause of database commands using this form.

· Wild match marker: Matches any input text from the current position to the end of a
statement. Wild match markers generally match input that may not be a legal
expression, such as
#command NOTE <*x*> in Clippers Std.ch, gather the input text to the end of
thestatement, and write it to the result text using one of the stringify result markers.

· Extended expression match marker: Matches a regular orextended expression,

including a file name or path specification. It is used with the smart stringify result
marker to ensure that extended expressions will not get stringified, while normal,
unquoted string file specifications will.

· Optional match clauses are portions of the match pattern enclosed in square brackets
([ ]). They specify a portion of the match pattern that may be absent from the input text.
An optional clause may contain any of the components allowed within a
<matchPattern>, including other optional clauses.

Optional match clauses may appear anywhere and in any order in the match pattern
and still match input text. Each match clause may appear only once in the input text.
There are two types of optional match clauses: one is a keyword followed by match
marker, and the other is a keyword by itself. These two types of optional match clauses
can match all of the traditional command clauses typical ofthe xBase command set.

Optional match clauses are defined with a regular or list match marker to match input
text if the clause consists of an argument or a keyword followed by an argument (see
the INDEX clause of the USE command in Std.ch). If the optional match clause
consists of a keyword by itself, it is matched with a restricted match marker (see the
EXCLUSIVE or SHARED clause of the USE command in Std.ch).

In any match pattern, you may not specify adjacent optional match clauses consisting
solely of match markers, without generating a compiler error. You may repeat an
optional clause any number of times in the input text, as long as it is not adjacent to any
other optional clause. To write a repeated match clause to the result text, use repeating
result clauses in the <resultPattern> definition.

© 2015- 2019 XSharp BV

275 XSharp Bandol

Result Pattern
The <resultPattern> portion of a translation directive is the text the preprocessor will
produce if a piece of input text matches the <matchPattern>. <resultPattern> is made
from one or more of the following components:

· Literal tokens are actual characters that are written directly to the result text.

· Words are xBase keywords and identifiers that are written directly to the result text.

· Result markers: refer directly to a match marker name. Input text matched by the
match marker is written to the result text via the result marker.

This table lists the Result marker forms:

Result Marker Name

<idMarker> Regular result marker
#<idMarker> Dumb stringify result marker
<"idMarker"> Normal stringify result marker
<(idMarker)> Smart stringify result marker
<{idMarker}> Blockify result marker
<.idMarker.> Logify result marker

· Regular result marker: Writes the matched input text to the result text, or nothing if no
input text is matched. Use this, the most general result marker, unless you have special
requirements. You can use it with any of the match markers, but it almost always is
used with the regular match marker.

· Dumb stringify result marker: Stringifies the matched input text and writes it to the
result text. If no input text is matched, it writes a null string (""). If the matched input text
is a list matched by a list match marker, this result marker stringifies the entire list and
writes it to the result text.

This result marker writes output to result text where a string is always required. This is
generally the case for commands where a command or clause argument is specified
as a literal value but the result text must always be written as a string even if the
argument is not specified.

· Normal stringify result marker: Stringifies the matched input text and writes it to the
result text. If no input text is matched, it writes nothing to the result text. If the matched
input text is a list matched by a list match marker, this result marker stringifies each
element in the list and writes it to the result text.

The normal stringify result marker is most often used with the blockify result marker to
compile an expression while saving a text image of the expression (See the SET
FILTER condition and the INDEX key expression in Std.ch).

© 2015- 2019 XSharp BV

 X# Documentation 276

· Smart stringify result marker: Stringifies matched input text only if source text is
enclosed in parentheses. If no input text matched, it writes nothing to the result text. If
the matched input text is a list matched by a list match marker, this result marker
stringifies each element in the list (using the same stringify rule) and writes it to the
result text.

The smart stringify result marker is designed specifically to support extended

expressions for commands other than SETs with <xlToggle> arguments. Extended
expressions are command syntax elements that can be specified as literal text or as an
expression if enclosed in parentheses. The <xcDatabase> argument of the USE
command is a typical example. For instance, if the matched input for the
<xcDatabase> argument is the word Customer, it is written to the result text as the
string "Customer," but the expression (cPath + cDatafile) would be written to the result
text unchanged (i.e., without quotes).

· Blockify result marker: Writes matched input text as a code block without any
arguments to the result text. For example, the input text x + 3 would be written to the
result text as {|| x + 3}. If no input text is matched, it writes nothing to the result text. If
the matched input text is a list matched by a list match marker, this result marker
blockifies each element in the list.

The blockify result marker used with the regular and list match markers matches
various kinds of expressions and writes them as code blocks to the result text.
Remember that a code block is a piece of compiled code to execute sometime later.
This is important when defining commands that evaluate expressions more than once
per invocation. When defining a command, you can use code blocks to pass an
expression to a function and procedure as data rather than as the result of an
evaluation. This allows the target routine to evaluate the expression whenever
necessary.

In Std.ch, the blockify result marker defines database commands where an expression
is evaluated for each record. Commonly, these are field or expression lists, FOR and
WHILE conditions, or key expressions for commands that perform actions based on key
values.

· Logify result marker: Writes true (.T.) to the result text if any input text is matched;
otherwise, it writes false (.F.) to the result text. This result marker does not write the
input text itself to the result text.

The logify result marker is generally used with the restricted match marker to write true
(.T.) to the result text if an optional clause is specified with no argument; otherwise, it
writes false (.F.). In Std.ch, this formulation defines the EXCLUSIVE and SHARED
clauses of the USE command.

· Repeating result clauses are portions of the <resultPattern> enclosed by square

brackets ([ ]). The text within a repeating clause is written to the result text as many
times as it has input text for any or all result markers within the clause. If there is no
matching input text, the repeating clause is not written to the result text. Repeating
clauses, however, cannot be nested. If you need to nest repeating clauses, you
probably need an additional
#command rule for the current command.

© 2015- 2019 XSharp BV

 277 XSharp Bandol

Repeating clauses are the result pattern part of the #command facility that create
optional clauses which have arguments. You can match input text with any match
marker other than the restricted match marker and write to the result text with any of the
corresponding result markers. Typical examples of this facility are the definitions for the
STORE and REPLACE commands in Std.ch.

Notes
· Less than operator: If you specify the less than operator (<) in the <resultPattern>
expression, you must precede it with the escape character (\).
· Multistatement lines: You can specify more than one statement as a part of the result
pattern by separating each statement with a semicolon. If you specify adjacent
statements on two separate lines, the first statement must be followed by two
semicolons.

1.7.1.4.2 #define

#define identifier [token-string]

or

#define identifier LPAREN parameters RPAREN

#define lets you define a symbol, such that, by using the symbol as the expression in a
#ifdef directive, the expression will evaluate to true or in a or #ifndef directive the
expression will evaluate to false.
#define also allows you define a symbolic name for a token string, so you can use the
symbolic name in your code and the preprocessor will replace all occurences of that
name with the token string that you have specified.
For example:

#define DEBUG
// ...
#if DEBUG
Console.WriteLine("Debug version");
#endif

or

#define VERSION "1.2.0.0"

#define FILEVERSION "1.2.3.4"
// ...
[assembly: AssemblyVersion(VERSION)]
[assembly: AssemblyFileVersion(FILEVERSION)]

© 2015- 2019 XSharp BV

 X# Documentation 278

A define with parentheses, such as

#define MAX(a,b) iif(a>b, a, b)

will be treated like a #translate.

Notes
Please note that defines are CASE SENSITIVE, so the following code will work:

#define TEST 123

FUNCTION Test() AS INT

RETURN TEST

but this will NOT compile:

#define TEST 123

FUNCTION TEST() AS INT

RETURN TEST

because the preprocessor will replace the name TEST in the FUNCTION line with the value
123 which is not a valid identifier. After preprocessing the code becomes:

FUNCTION 123() AS INT

RETURN 123

1.7.1.4.3 #else

#else lets you create a compound conditional directive, so that, if the expression in the
preceding #ifdef directive or #ifndef directive does not evaluate to true, the compiler will
evaluate all code between #else and the subsequent #endif.
For example, the following code will show the string "Debug Version" if the symbol
DEBUG is defined on the command line, else it will show the text "Release Version"

// DEBUG may be defined from the command line

// ...
#if DEBUG
Console.WriteLine("Debug version");
#else
Console.WriteLine("Release version");
#endif

© 2015- 2019 XSharp BV

 279 XSharp Bandol

1.7.1.4.4 #endif

#endif specifies the end of a conditional directive, which began with the #ifdef or #ifndef
directive. For example:

// DEBUG may be defined from the command line

// ...
#if DEBUG
Console.WriteLine("Debug version");
#else
Console.WriteLine("Release version");
#endif

1.7.1.4.5 #ifdef

When the X# compiler encounters an #ifdef directive, followed eventually by an #endif

directive, it will compile the code between the directives only if the specified symbol is
defined.
The #ifdef statement in X# is Boolean and only tests whether the symbol has been defined
or not. For example,

// DEBUG may be defined from the command line

// ...
#if DEBUG
Console.WriteLine("Debug version");
#else
Console.WriteLine("Release version");
#endif

Note
The /vo8 compiler option will change this behavior:
when /vo8 is active then any symbol defined with TRUE or a non-0 numeric value will be
seen as "defined", symbols defined with FALSE or a 0 numeric value will be seen as
"undefined".

1.7.1.4.6 #ifndef

When the X# compiler encounters an #ifndef directive, followed eventually by an #endif

directive, it will compile the code between the directives only if the specified symbol is
NOT defined.
The #ifndef statement in X# is Boolean and only tests whether the symbol has been
defined or not. For example,

// DEBUG may be defined from the command line

// ...
#if DEBUG
Console.WriteLine("Debug version");
#else

© 2015- 2019 XSharp BV

 X# Documentation 280

Console.WriteLine("Release version");
#endif

Note
when /vo8 is active then any symbol defined with FALSE or a 0 numeric value will also be
seen as "undefined".

1.7.1.4.7 #include

Tells the preprocessor to treat the contents of a specified file as if they appear in the
source program at the point where the directive appears.

#include "path-spec"

You can preprocessor definitions into include files and then use #include directives to add
them to any source file.
The path-spec is a file name that may optionally be preceded by a directory specification.
The file name must name an existing file.
The preprocessor searches for include files in this order:
1. In the same directory as the file that contains the #include statement.
2. Along the path that's specified by each /I compiler option.
3. In the Include folder inside the XSharp installation folder
4. Along the paths that are specified by the INCLUDE environment variable. (Not
supported yet)

1.7.1.4.8 #line

#line sets the current line number for the compiler. It is usually inserted by the
preprocessor after preprocessing an include file to synchronize the line numbers with the
original source file.

#line <number> [FileName]

where:
line number the new line number to use by the compiler.
FileName An optional new filename to use by the compiler

1.7.1.4.9 #pragma

The #pragma directive allow you to suppress certain compiler warnings for a piece of
code. It is not supported yet.

© 2015- 2019 XSharp BV

 281 XSharp Bandol

1.7.1.4.10 #region - #endregion

#region lets you specify a block of code that you can expand or collapse when using the
outlining feature of the Visual Studio Code Editor. In longer code files, it is convenient to be
able to collapse or hide one or more regions so that you can focus on the part of the file
that you are currently working on. The following example shows how to define a region:

#region MyClass definition

CLASS MyClass
EXPORT Name as STRING
END CLASS
#endregion

Comments
A #region block must be terminated with a #endregion directive.
A #region block cannot overlap with a #ifdef block or an #ifndef block. However, a #region
block can be nested in a #ifdef or #ifndef block, and a #ifdef or #ifndef block can be nested
in a #region block.
For now the compiler does not enforce this, but it will in the not too far future.
A #region and #endregion block may have optional comments after the #region and
#endregion keyword. The compiler will ignore everything after the keyword until the end of
the line

1.7.1.4.11 #translate and #xtranslate

Specify a user-defined translation directive

Syntax

#translate <matchPattern> => <resultPattern>

#xtranslate <matchPattern> => <resultPattern>

Arguments
<matchPattern> is the pattern the input text should match.

<resultPattern> is the text produced if a portion of input text matches the

<matchPattern>.

The => symbol between <matchPattern> and <resultPattern> is, along with#command or
#translate, a literal part of the syntax that must be specified in a #command or #translate
directive. The symbol consists of an equal sign followed by a greater than symbol with no
intervening spaces. Do not confuse the symbol with the >= or the <= comparison
operators in the xBase language.

Description
#command and #translate are translation directives that define commands and
pseudofunctions. Each directive specifies a translation rule. The rule consists of two
portions: a match pattern and a result pattern.

© 2015- 2019 XSharp BV

 X# Documentation 282

The match pattern matches a command specified in the program (.prg) file and saves
portions of the command text (usually command arguments) for the result pattern to use.
The result pattern then defines what will be written to the result text and how it will be
written using the saved portions of the matching input text.

#command and #translate are similar, but differ in the circumstance under which their
match patterns match input text. A #command directive matches only if the input text is a
complete statement, while #translate matches input text that is not a complete statement.
#command defines a complete command and #translate defines clauses and
pseudofunctions that may not form a complete statement. In general, use #command for
most definitions and #translate for special cases.

#command and #translate are similar to but more powerful than the #define directive.
#define, generally, defines identifiers that control conditional compilation and manifest
constants for commonly used constant values such as SDK codes. Refer to any of the
header files in the INCLUDE directory for examples of manifest constants defined using
#define.

#command and #translate directives have the same scope as the #define directive. The
definition is valid only for the current program (.prg) file unless defined in Std.ch or the
header specified with the /U option on the compiler command line. If defined elsewhere,
the definition is valid from the line where it is specified to the end of the program file.
Unlike #define, a #translate or #command definition cannot be explicitly undefined. The
#undef directive has no effect on a #command or #translate definition.

As the preprocessor encounters each source line preprocessor, it scans for definitions in
the following order of precedence: #define, #translate, and #command. When there is a
match, the substitution is made to the result text and the entire line is reprocessed until
there are no matches for any of the three types of definitions. #command and #translate
rules are processed in stack-order (i.e., last in-first out, with the most recently specified
rule processed first).

In general, a command definition provides a way to specify an English language statement

that is, in fact, a complicated expression or function call, thereby improving the readability
of source code. You can use a command in place of an expression or function call to
impose order of keywords, required arguments, combinations of arguments that must be
specified together, and mutually exclusive arguments at compile time rather than at
runtime. This can be important since procedures and user-defined functions can now be
called with any number of arguments, forcing any argument checking to occur at runtime.
With command definitions, the preprocessor handles some of this.

When defining a command, there are several prerequisites to properly specifying the
command definition. Many preprocessor commands require more than one #command
directive because mutually exclusive clauses contain a keyword or argument. For
example, the @...GET command has mutually exclusive VALID and RANGE clauses and
is defined with a different #command rule to implement each clause.

This also occurs when a result pattern contains different expressions, functions, or
parameter structures for different clauses specified for the same command (e.g., the
@...SAY command). In Std.ch, there is a #command rule for @...SAY specified with the
PICTURE clause and another for @...SAY specified without the PICTURE clause. Each
formulation of the command is translated into a different expression.

© 2015- 2019 XSharp BV

283 XSharp Bandol

Because directives are processed in stack order, when defining more than one rule for a
command, place the most general case first, followed by the more specific ones. This
ensures that the proper rule will match the command specified in the program (.prg) file.

Match Pattern
The <matchPattern> portion of a translation directive is the pattern the input text must
match. A match pattern is made from one or more of the following components, which
the preprocessor tries to match against input text in a specific way:

· Literal values are actual characters that appear in the match pattern. These characters
must appear in the input text, exactly as specified to activate the translation directive.

· Words are keywords and valid identifiers that are compared according to the dBASE
convention (case-insensitive, first four letters mandatory, etc.). The match pattern must
start with a Word.

· #xcommand and #xtranslate can recognize keywords of more than four significant
letters.

· Match markers are label and optional symbols delimited by angle brackets (<>) that
provide a substitute (idMarker) to be used in the <resultPattern> and identify the clause
for which it is a substitute. Marker names are identifiers and must, therefore, follow the
xBase identifier naming conventions. In short, the name must start with an alphabetic or
underscore character, which may be followed by alphanumeric or underscore
characters.

This table describes all match marker forms:

Match Marker Name

<idMarker> Regular match marker
<idMarker,...> List match marker
<idMarker:word list> Restricted match marker
<*idMarker*> Wild match marker
<(idMarker)> Extended Expression match marker

· Regular match marker: Matches the next legal expression in the input text. The regular
match marker, a simple label, is the most general and, therefore, the most likely match
marker to use for a command argument. Because of its generality, it is used with the
regular result marker, all of the stringify result markers, and the blockify result marker.

· List match marker: Matches a comma-separated list of legal expressions. If no input

text matches the match marker, the specified marker name contains nothing. You must
take care in making list specifications because extra commas will cause unpredictable
and unexpected results.

The list match marker defines command clauses that have lists as arguments.
Typically these are FIELDS clauses or expression lists used by database commands.
When there is a match for a list match marker, the list is usually written to the result text

© 2015- 2019 XSharp BV

 X# Documentation 284

using either the normal or smart stringify result marker. Often, lists are written as literal
arrays by enclosing the result marker in curly ({ }) braces.

· Restricted match marker: Matches input text to one of the words in a comma-
separated list. If the input text does not match at least one of the words, the match fails
and the marker name contains nothing.

A restricted match marker is generally used with the logify result marker to write a
logical value into the result text. If there is a match for the restricted match marker, the
corresponding logify result marker writes true (.T.) to the result text; otherwise, it writes
false (.F.). This is particularly useful when defining optional clauses that consist of a
command keyword with no accompanying argument. Std.ch implements the REST
clause of database commands using this form.

· Wild match marker: Matches any input text from the current position to the end of a
statement. Wild match markers generally match input that may not be a legal
expression, such as
#command NOTE <*x*> in Clippers Std.ch, gather the input text to the end of
thestatement, and write it to the result text using one of the stringify result markers.

· Extended expression match marker: Matches a regular orextended expression,

including a file name or path specification. It is used with the smart stringify result
marker to ensure that extended expressions will not get stringified, while normal,
unquoted string file specifications will.

· Optional match clauses are portions of the match pattern enclosed in square brackets
([ ]). They specify a portion of the match pattern that may be absent from the input text.
An optional clause may contain any of the components allowed within a
<matchPattern>, including other optional clauses.

Optional match clauses may appear anywhere and in any order in the match pattern
and still match input text. Each match clause may appear only once in the input text.
There are two types of optional match clauses: one is a keyword followed by match
marker, and the other is a keyword by itself. These two types of optional match clauses
can match all of the traditional command clauses typical ofthe xBase command set.

Optional match clauses are defined with a regular or list match marker to match input
text if the clause consists of an argument or a keyword followed by an argument (see
the INDEX clause of the USE command in Std.ch). If the optional match clause
consists of a keyword by itself, it is matched with a restricted match marker (see the
EXCLUSIVE or SHARED clause of the USE command in Std.ch).

In any match pattern, you may not specify adjacent optional match clauses consisting
solely of match markers, without generating a compiler error. You may repeat an
optional clause any number of times in the input text, as long as it is not adjacent to any
other optional clause. To write a repeated match clause to the result text, use repeating
result clauses in the <resultPattern> definition.

Result Pattern
The <resultPattern> portion of a translation directive is the text the preprocessor will
produce if a piece of input text matches the <matchPattern>. <resultPattern> is made
from one or more of the following components:

© 2015- 2019 XSharp BV

285 XSharp Bandol

· Literal tokens are actual characters that are written directly to the result text.

· Words are xBase keywords and identifiers that are written directly to the result text.

· Result markers: refer directly to a match marker name. Input text matched by the
match marker is written to the result text via the result marker.

This table lists the Result marker forms:

Result Marker Name

<idMarker> Regular result marker
#<idMarker> Dumb stringify result marker
<"idMarker"> Normal stringify result marker
<(idMarker)> Smart stringify result marker
<{idMarker}> Blockify result marker
<.idMarker.> Logify result marker

· Regular result marker: Writes the matched input text to the result text, or nothing if no
input text is matched. Use this, the most general result marker, unless you have special
requirements. You can use it with any of the match markers, but it almost always is
used with the regular match marker.

· Dumb stringify result marker: Stringifies the matched input text and writes it to the
result text. If no input text is matched, it writes a null string (""). If the matched input text
is a list matched by a list match marker, this result marker stringifies the entire list and
writes it to the result text.

This result marker writes output to result text where a string is always required. This is
generally the case for commands where a command or clause argument is specified
as a literal value but the result text must always be written as a string even if the
argument is not specified.

· Normal stringify result marker: Stringifies the matched input text and writes it to the
result text. If no input text is matched, it writes nothing to the result text. If the matched
input text is a list matched by a list match marker, this result marker stringifies each
element in the list and writes it to the result text.

The normal stringify result marker is most often used with the blockify result marker to
compile an expression while saving a text image of the expression (See the SET
FILTER condition and the INDEX key expression in Std.ch).

· Smart stringify result marker: Stringifies matched input text only if source text is
enclosed in parentheses. If no input text matched, it writes nothing to the result text. If
the matched input text is a list matched by a list match marker, this result marker
stringifies each element in the list (using the same stringify rule) and writes it to the
result text.

© 2015- 2019 XSharp BV

 X# Documentation 286

The smart stringify result marker is designed specifically to support extended

expressions for commands other than SETs with <xlToggle> arguments. Extended
expressions are command syntax elements that can be specified as literal text or as an
expression if enclosed in parentheses. The <xcDatabase> argument of the USE
command is a typical example. For instance, if the matched input for the
<xcDatabase> argument is the word Customer, it is written to the result text as the
string "Customer," but the expression (cPath + cDatafile) would be written to the result
text unchanged (i.e., without quotes).

· Blockify result marker: Writes matched input text as a code block without any
arguments to the result text. For example, the input text x + 3 would be written to the
result text as {|| x + 3}. If no input text is matched, it writes nothing to the result text. If
the matched input text is a list matched by a list match marker, this result marker
blockifies each element in the list.

The blockify result marker used with the regular and list match markers matches
various kinds of expressions and writes them as code blocks to the result text.
Remember that a code block is a piece of compiled code to execute sometime later.
This is important when defining commands that evaluate expressions more than once
per invocation. When defining a command, you can use code blocks to pass an
expression to a function and procedure as data rather than as the result of an
evaluation. This allows the target routine to evaluate the expression whenever
necessary.

In Std.ch, the blockify result marker defines database commands where an expression
is evaluated for each record. Commonly, these are field or expression lists, FOR and
WHILE conditions, or key expressions for commands that perform actions based on key
values.

· Logify result marker: Writes true (.T.) to the result text if any input text is matched;
otherwise, it writes false (.F.) to the result text. This result marker does not write the
input text itself to the result text.

The logify result marker is generally used with the restricted match marker to write true
(.T.) to the result text if an optional clause is specified with no argument; otherwise, it
writes false (.F.). In Std.ch, this formulation defines the EXCLUSIVE and SHARED
clauses of the USE command.

· Repeating result clauses are portions of the <resultPattern> enclosed by square

brackets ([ ]). The text within a repeating clause is written to the result text as many
times as it has input text for any or all result markers within the clause. If there is no
matching input text, the repeating clause is not written to the result text. Repeating
clauses, however, cannot be nested. If you need to nest repeating clauses, you
probably need an additional
#command rule for the current command.

Repeating clauses are the result pattern part of the #command facility that create
optional clauses which have arguments. You can match input text with any match
marker other than the restricted match marker and write to the result text with any of the
corresponding result markers. Typical examples of this facility are the definitions for the
STORE and REPLACE commands in Std.ch.

© 2015- 2019 XSharp BV

 287 XSharp Bandol

Notes
· Less than operator: If you specify the less than operator (<) in the <resultPattern>
expression, you must precede it with the escape character (\).
· Multistatement lines: You can specify more than one statement as a part of the result
pattern by separating each statement with a semicolon. If you specify adjacent
statements on two separate lines, the first statement must be followed by two
semicolons.

1.7.1.4.12 #undef

#undef identifier

#undef lets you undefine a symbol, such that, by using the symbol as the expression in a
#ifdef directive, the expression will evaluate to false or in a or #ifndef directive the
expression will evaluate to true.

1.7.1.5 X# Walkthroughs
Enter topic text here.

1.7.1.6 Pragma Statements

Enter topic text here.

1.7.2 X# Compiler Options

The X# compiler is a command line tool named xsc.exe. This tool can be controlled using
command line options. The following pages describe these command line options.

1.7.2.1 Command-line Building With xsc.exe

You can invoke the X# compiler by typing the name of its executable file (xsc.exe) at a
command prompt.

If you use a standard Command Prompt window, you must adjust your path before you
can invoke xsc.exe from any subdirectory on your computer.

You can also use MSBuild to build X# programs programmatically. For more information,
see the MSBuild documentation on MSDN.

The xsc.exe executable file usually is located in the {Program Files}\XSharp\Bin folder
under the Windows directory.

When you build programs with the Visual Studio IDE then Visual Studio will locate the X#
compiler automatically for you and the build output from the compiler will be shown in the
Output Windows of Visual Studio.
You can set the verbosity level of the compiler output from the Tools/Options, Projects
and Solutions, Build and Run page.

© 2015- 2019 XSharp BV

 X# Documentation 288

Rules for Command-Line Syntax for the X# Compiler

The X# compiler uses the following rules when it interprets arguments given on the
operating system command line:

· Arguments are delimited by white space, which is either a space or a tab.

· The caret character (^) is not recognized as an escape character or delimiter. The
character is handled by the command-line parser in the operating system before it is
passed to the argv array in the program.
· A string enclosed in double quotation marks ("string") is interpreted as a single
argument, regardless of white space that is contained within. A quoted string can be
embedded in an argument.
· A double quotation mark preceded by a backslash (\") is interpreted as a literal double
quotation mark character (").
· Backslashes are interpreted literally, unless they immediately precede a double
quotation mark.
· If an even number of backslashes is followed by a double quotation mark, one
backslash is put in the compiler options array for every pair of backslashes, and the
double quotation mark is interpreted as a string delimiter.
· If an odd number of backslashes is followed by a double quotation mark, one backslash
is put in the compiler options array for every pair of backslashes, and the double
quotation mark is "escaped" by the remaining backslash. This causes a literal double
quotation mark (") to be added in compiler options array.
· Commandline options can start with a hyphen (-) or a slash (/). On Non windows
platforms the hyphen should be used because the slash may be seen as a path
delimiter character

Sample commands for the X# Compiler

xcs file.prg Compile File.prg and produce File.exe

xcs -target:library file.prg Compile File.prg and produce File.dll

xcs -out:Program.exe file.prg Compile File.prg and produce Program.exe

xsc -define:DEBUG -optimize -out:File.exe *.prg Compiles all the X# files in the current
directory, with optimizations on and defines
the DEBUG symbol. The output is File2.exe

xsc /target:library /out:File2.dll /warn:0 /nologo / Compiles all the X# files in the current
debug *.prg directory producing a debug version of
File2.dll. No logo and no warnings are
displayed

xsc /target:library /out:MyBase.rdd *.prg Compiles all the X# files in the current
directory to MyBase.rdd (a DLL):

© 2015- 2019 XSharp BV

 289 XSharp Bandol

1.7.2.2 X# Compiler Options By Category

The following compiler options are sorted by category. For an alphabetical list, see : X#
Compiler Options Listed Alphabetically
The options in RED are not supported yet.

Dialect support

Option Purpose
-dialect Specifies the dialect to use when compiling. The following
values are supported: Core, VO, Vulcan, dBase, FoxPro,
xBase++ and Harbour. Work on the VO and Vulcan
dialects has started.

XBase Compatibility

Option Purpose
-az Specifies that arrays are zero-based rather than one-
based
-cs Specifies that the compiler should use case-sensitive type
names
-d Instruct the compiler to emit debugging information. (short
for /debug)
-fovf Specifies that exceptions will be raised on invalid floating
point operations
-i Specifies a directory to add to the #include file search
path
-ins Use implicit namespace lookup mechanism
-lb Specifies that the compiler should generate late bound
calls when necessary
-memvar Enables support for memory variables
-namedargs Specifies whether to allow named arguments in the parser
or not.
-nostddefs Suppresses preprocessor definitions in XSharpDefs.xh
-ns Specify the default namespace for the output assembly
-ovf Specifies that exceptions will be raised on integer
overflows
-ppo Writes preprocessor output to file

© 2015- 2019 XSharp BV

 X# Documentation 290

Option Purpose
-showincludes Lists #include files in compiler output
-snk Signs assembly with strong name key pair
-undeclared Enables support for undeclared variables
-vo1 Use Init and Axit methods in stead of Constructors and
Destructors
-vo2 Initialize STRING variables, fields and DIM arrays to empty
strings
-vo3 Treats All Methods As VIRTUAL
-vo4 Allows implicit signed/unsigned integer conversions
-vo5 Implicit CLIPPER Calling Convention for Zero-Argument
Functions
-vo6 Resolves typed function pointers to PTR
-vo7 Allows compatible implicit casts and conversions
-vo8 Enables compatible preprocessor behavior
-vo9 Allows missing RETURN statements
-vo10 Enables compatible IIF behavior
-vo11 Enables Visual Objects compatible arithmetic
conversions
-vo12 Enables Clipper compatible integer divisions
-vo13 Enables Visual Objects compatible string comparisons
-vo14 Insert floating point literals as FLOAT
-vo15 Allow untyped Locals and return types
-vo16 Automatically generate Clipper calling convention
constructors for classes without constructor
-w This option is not supported. use -NoWarn in stead
-wx Treats all warnings as errors (alias for -warnaserror)

Optimization

Option Purpose
-filealign Specifies the size of sections in the output file.
-optimize Enables/disables optimizations.

Output files

© 2015- 2019 XSharp BV

291 XSharp Bandol

Option Purpose
-doc Specifies an XML file where processed documentation
comments are to be written.
-modulename Specify the name of the source module
-out Specifies the output file.
-pathmap Specify a mapping for source path names output by the
compiler.
-pdb Specifies the file name and location of the .pdb file.
-platform Specify the output platform.
-preferreduilang Specify a language for compiler output.
-target Specifies the format of the output file using one of five
options: /target:appcontainerexe, /target:exe, /target:library,
/target:module, /target:winexe, or /target:winmdobj.
-touchedfiles Specify filename that will be updated with list of files read
and written by the compiler

.NET Assemblies

Option Purpose
-analyzer Run the analyzers from this assembly (Short form: /a)
-additionalfile Names additional files that don't directly affect code
generation but may be used by analyzers for producing
errors or warnings.
-addmodule Specifies one or more modules to be part of this
assembly.
-delaysign Instructs the compiler to add the public key but to leave the
assembly unsigned.
-keycontainer Specifies the name of the cryptographic key container.
-keyfile Specifies the filename containing the cryptographic key.
-lib Specifies the location of assemblies referenced by means
of /reference.
-nostdlib Instructs the compiler not to import the standard library
(mscorlib.dll).
-reference Imports metadata from a file that contains an assembly.

Debugging / Error checking

© 2015- 2019 XSharp BV

 X# Documentation 292

Option Purpose
-checked Specifies whether integer arithmetic that overflows the
bounds of the data type will cause an exception at run
time.
-debug Instruct the compiler to emit debugging information.
-errorendlocation Output line and column of the end location of each error
-errorreport Sets error reporting behavior.
-fullpaths Specifies the absolute path to the file in compiler output.
-nowarn Suppresses the compiler's generation of specified
warnings.
-ruleset Specify a ruleset file that disables specific diagnostics.
-warn Sets the warning level.
-warnaserror Promotes warnings to errors.
-wx This is an alias for the -warnaserror option

Preprocessor

Option Purpose
-define Defines preprocessor symbols.
-i Specifies a directory to add to the #include file search
path
-ppo Writes preprocessor output to file
-nostddef Suppresses preprocessor definitions in XSharpDefs.xh
-showdefs Show the defines that are added from the header files and
their usage
-showincludes Lists #include files in compiler output

Resources

Option Purpose
-link Makes COM type information in specified assemblies
available to the project.
-linkresource Creates a link to a managed resource.
-resource Embeds a .NET Framework resource into the output file.
-win32icon Specifies an .ico file to insert into the output file.

© 2015- 2019 XSharp BV

293 XSharp Bandol

Option Purpose
-win32res Specifies a Win32 resource to insert into the output file.

Miscellaneous

Option Purpose
@ Specifies a response file.
-? Lists compiler options to stdout.
-appconfig Specify an application configuration file containing
assembly binding settings
-baseaddress Specifies the preferred base address at which to load a
DLL.
-checksumalgorithm Specify the algorithm for calculating the source file
checksum stored in PDB. Supported values are: SHA1
(default) or SHA256.
-codepage Specifies the code page to use for all source code files in
the compilation.
-help Lists compiler options to stdout.
-highentropyva Specifies that the executable file supports address space
layout randomization (ASLR).
-langversion Specify language version mode: core, VO, Vulcan,
Harbour, FoxPro, dBase
-main Specifies the location of the Main method.
-noconfig Instructs the compiler not to compile with xsc.rsp.
-nologo Suppresses compiler banner information.
-parallel Specifies whether to use concurrent build (+).
-recurse Searches subdirectories for source files to compile.
-s Syntax check only
-subsystemversion Specifies the minimum version of the subsystem that the
executable file can use.
-unsafe Enables compilation of code that uses the unsafe
keyword.
-utf8output Displays compiler output using UTF-8 encoding.
-win32manifest Specify a user-defined Win32 application manifest file to
be embedded into a executable file.

© 2015- 2019 XSharp BV

 X# Documentation 294

1.7.2.3 X# Compiler Options Listed Alphabetically

The following compiler options are sorted by category. For an alphabetical list, see : X#
Compiler Options Listed Alphabetically
The options in RED are not supported yet.

Option Purpose
@ Specifies a response file.
-? Lists compiler options to stdout.
-additionalfile Names additional files that don't directly affect code
generation but may be used by analyzers for producing
errors or warnings.
-addmodule Specifies one or more modules to be part of this
assembly.
-analyzer Run the analyzers from this assembly (Short form: /a)
-appconfig Specify an application configuration file containing
assembly binding settings
-az Specifies that arrays are zero-based rather than one-
based
-baseaddress Specifies the preferred base address at which to load a
DLL.
-checked Specifies whether integer arithmetic that overflows the
bounds of the data type will cause an exception at run
time.
-checksumalgorithm Specify the algorithm for calculating the source file
checksum stored in PDB. Supported values are: SHA1
(default) or SHA256.
-codepage Specifies the code page to use for all source code files in
the compilation.
-cs Specifies that the compiler should use case-sensitive type
names
-debug -d Instruct the compiler to emit debugging information.
-define Defines preprocessor symbols.
-dialect Specifies the dialect to use when compiling. The following
values are supported: Core, VO, Vulcan, dBase, FoxPro,
xBase++ and Harbour. Work on the VO and Vulcan
dialects has started.
-delaysign Instructs the compiler to add the public key but to leave the
assembly unsigned.
-doc Specifies an XML file where processed documentation
comments are to be written.
-errorendlocation Output line and column of the end location of each error

© 2015- 2019 XSharp BV

295 XSharp Bandol

Option Purpose
-errorreport Sets error reporting behavior.
-filealign Specifies the size of sections in the output file.
-fovf Specifies that exceptions will be raised on invalid floating
point operations
-fullpaths Specifies the absolute path to the file in compiler output.
-help Lists compiler options to stdout.
-highentropyva Specifies that the executable file supports address space
layout randomization (ASLR).
-i Specifies a directory to add to the #include file search
path
-ins Use implicit namespace lookup mechanism
-keycontainer Specifies the name of the cryptographic key container.
-keyfile Specifies the filename containing the cryptographic key.
-lb Specifies that the compiler should generate late bound
calls when necessary
-langversion Specify language version mode: core, VO, Vulcan,
Harbour, FoxPro, dBase
-lib Specifies the location of assemblies referenced by means
of /reference.
-link Makes COM type information in specified assemblies
available to the project.
-linkresource Creates a link to a managed resource.
-main Specifies the location of the Main method.
-memvar Enable support for memory variables
-modulename Specify the name of the source module
-namedargs Specifies whether to allow named arguments in the parser
or not.
-nostddefs Suppresses preprocessor definitions in XSharpDefs.xh
-ns Specify the default namespace for the output assembly
-noconfig Instructs the compiler not to compile with xsc.rsp.
-nologo Suppresses compiler banner information.
-nostdlib Instructs the compiler not to import the standard library
(mscorlib.dll).
-nowarn Suppresses the compiler's generation of specified
warnings.

© 2015- 2019 XSharp BV

 X# Documentation 296

Option Purpose
-optimize Enables/disables optimizations.
-ovf Specifies that exceptions will be raised on integer
overflows
-out Specifies the output file.
-parallel Specifies whether to use concurrent build (+).
-pathmap Specify a mapping for source path names output by the
compiler.
-pdb Specifies the file name and location of the .pdb file.
-platform Specify the output platform.
-ppo Writes preprocessor output to file
-preferreduilang Specify a language for compiler output.
-recurse Searches subdirectories for source files to compile.
-reference Imports metadata from a file that contains an assembly.
-resource Embeds a .NET Framework resource into the output file.
-ruleset Specify a ruleset file that disables specific diagnostics.
-s Syntax check only
-showdefs Show the defines that are added from the header files and
their usage
-showincludes Lists #include files in compiler output
-snk Signs assembly with strong name key pair
-subsystemversion Specifies the minimum version of the subsystem that the
executable file can use.
-target Specifies the format of the output file using one of five
options: /target:appcontainerexe, /target:exe, /target:library,
/target:module, /target:winexe, or /target:winmdobj.
-touchedfiles Specify filename that will be updated with list of files read
and written by the compiler
-undeclared Enables the support for undeclared memory variables
-unsafe Enables compilation of code that uses the unsafe
keyword.
-utf8output Displays compiler output using UTF-8 encoding.
-vo1 Use Init and Axit methods in stead of Constructors and
Destructors
-vo2 Initialize STRING variables, fields and DIM arrays to empty
strings

© 2015- 2019 XSharp BV

 297 XSharp Bandol

Option Purpose
-vo3 Treats All Methods As VIRTUAL
-vo4 Allows implicit signed/unsigned integer conversions
-vo5 Implicit CLIPPER Calling Convention for Zero-Argument
Functions
-vo6 Resolves typed function pointers to PTR
-vo7 Allows compatible implicit casts and conversions
-vo8 Enables compatible preprocessor behavior
-vo9 Allows missing RETURN statements
-vo10 Enables compatible IIF behavior
-vo11 Enables Visual Objects compatible arithmetic
conversions
-vo12 Enables Clipper compatible integer divisions
-vo13 Enables Visual Objects compatible string comparisons
-vo14 Insert floating point literals as FLOAT
-vo15 Allow untyped Locals and return types
-vo16 Automatically generate Clipper calling convention
constructors for classes without constructor
-w This option is not supported. use -NoWarn in stead
-warn Sets the warning level.
-warnaserror Promotes warnings to errors.
-win32icon Specifies an .ico file to insert into the output file.
-win32manifest Specify a user-defined Win32 application manifest file to
be embedded into a executable file.
-win32res Specifies a Win32 resource to insert into the output file.
-wx Treats all warnings as errors (alias for -warnaserror)

1.7.2.3.1 @

The @ option lets you specify a file that contains compiler options and source code files to
compile.

Syntax

@response_file

© 2015- 2019 XSharp BV

 X# Documentation 298

Arguments
response_file A file that lists compiler options or source code files to compile.

Remarks
The compiler options and source code files will be processed by the compiler just as if
they had been specified on the command line.

To specify more than one response file in a compilation, specify multiple response file
options. For example:

@file1.rsp @file2.rsp

In a response file, multiple compiler options and source code files can appear on one line.
A single compiler option specification must appear on one line (cannot span multiple
lines). Response files can have comments that begin with the # symbol.

Specifying compiler options from within a response file is just like issuing those
commands on the command line. See Building from the Command Line for more
information.

The compiler processes the command options as they are encountered. Therefore,
command line arguments can override previously listed options in response files.
Conversely, options in a response file will override options listed previously on the
command line or in other response files.

X# provides the xsc.rsp file, which is located in the same directory as the xsc.exe file. See
-noconfig for more information on xsc.rsp.

This compiler option cannot be set in the Visual Studio development environment, nor can
it be changed programmatically.

Example
The following are a few lines from a sample response file:

# build the first output file

-target:exe -out:MyExe.exe source1.prg source2.prg

© 2015- 2019 XSharp BV

 299 XSharp Bandol

1.7.2.3.2 -additionalfile

The -additionalfile commandline option allows you to include extra files in the assembly.
To support this scenario the X# compiler can accept additional, non-source text files as
inputs.
Syntax

-additionalfile:file

For example, an analyzer may enforce that a set of banned terms is not used within a
project, or that every source file has a certain copyright header. The terms or copyright
header could be passed to the analyzer as an additional file, rather than being hard-coded
in the analyzer itself.
Example
On the command line, additional files can be passed using The -additionalfile option. For
example:

xsc alpha.prg -additionalfile:terms.txt

1.7.2.3.3 -addmodule

This option adds a module that was created with the target:module switch to the current
compilation.

Syntax

-addmodule:file[;file2]

Arguments
file, file2 An output file that contains metadata. The file cannot contain an
assembly manifest. To import more than one file, separate file names
with either a comma or a semicolon.

Remarks
All modules added with -addmodule must be in the same directory as the output file at run
time. That is, you can specify a module in any directory at compile time but the module

© 2015- 2019 XSharp BV

 X# Documentation 300

must be in the application directory at run time. If the module is not in the application
directory at run time, you will get a TypeLoadException.

file cannot contain an assembly. For example, if the output file was created with -
target:module, its metadata can be imported with -addmodule.

If the output file was created with a -target option other than -target:module, its metadata
cannot be imported with -addmodule but can be imported with -reference.

This compiler option is unavailable in Visual Studio; a project cannot reference a module.
In addition, this compiler option cannot be changed programmatically.

Example
Compile source file input.prg and add metadata from metad1.netmodule and
metad2.netmodule to produce out.exe:

xsc -addmodule:metad1.netmodule;metad2.netmodule -out:out.exe input.prg

1.7.2.3.4 -analyzer, -a

Run the analyzers from this assembly

1.7.2.3.5 -appconfig

The -appconfig compiler option enables a X# application to specify the location of an

assembly's application configuration (app.config) file to the common language runtime
(CLR) at assembly binding time.

Syntax

-appconfig:file

Arguments
file Required. The application configuration file that contains assembly
binding settings.

Remarks
One use of -appconfig is advanced scenarios in which an assembly has to reference both
the .NET Framework version and the .NET Framework for Silverlight version of a
particular reference assembly at the same time. For example, a XAML designer written in

© 2015- 2019 XSharp BV

301 XSharp Bandol

Windows Presentation Foundation (WPF) might have to reference both the WPF
Desktop, for the designer's user interface, and the subset of WPF that is included with
Silverlight. The same designer assembly has to access both assemblies. By default, the
separate references cause a compiler error, because assembly binding sees the two
assemblies as equivalent.

The -appconfig compiler option enables you to specify the location of an app.config file
that disables the default behavior by using a <supportPortability> tag, as shown in the
following example.

<supportPortability PKT="7cec85d7bea7798e" enable="false"/>

The compiler passes the location of the file to the CLR's assembly-binding logic.
 
Note
If you are using the Microsoft Build Engine (MSBuild) to build your application, you can set
The -appconfig compiler option by adding a property tag to the .xsproj file. To use the
app.config file that is already set in the project, add property tag
<UseAppConfigForCompiler> to the .xsproj file and set its value to true. To specify a
different app.config file, add property tag <AppConfigForCompiler> and set its value to the
location of the file.

Example
The following example shows an app.config file that enables an application to have
references to both the .NET Framework implementation and the .NET Framework for
Silverlight implementation of any .NET Framework assembly that exists in both
implementations. The -appconfig compiler option specifies the location of this app.config
file.

<configuration>
<runtime>
<assemblyBinding>
<supportPortability PKT="7cec85d7bea7798e" enable="false"/>
<supportPortability PKT="31bf3856ad364e35" enable="false"/>
</assemblyBinding>
</runtime>
</configuration>

© 2015- 2019 XSharp BV

 X# Documentation 302

1.7.2.3.6 -az

The -az option specifies that array elements begin with 0, rather than with 1 (the default).

Syntax

-az[+|-]

Arguments
+ |- Specifying +, or just -az, directs the compiler to use 0-based array
indexing rather than 1-based indexing.

Remarks
This option is off by default, since it would break existing Visual Objects source code. If
you prefer to use 0-based arrays with existing code written for Visual Objects, you will
need to examine every place in your source code that uses arrays and manually make the
appropriate adjustments.

Note: This option does not affect how the assembly being compiled is used from other
applications. When The -az option is not used, the compiler generates code to subtract 1
from the array index in order to provide 1-based array indexing semantics at the language
level. When The -az option is used, the compiler does not adjust array indexes. Either
way, the resulting arrays are always 0-based at the IL level, which allows compatibility with
all other .NET languages.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Language tab.
3. In the General section, modify the "Use Zero Based Arrays" property.

Example

FUNCTION Start() AS VOID

LOCAL DIM a[1] AS INT
? a[0] -/ runtime error when -az switch is NOT used
? a[1] -/ runtime error when -az switch is used
RETURN

© 2015- 2019 XSharp BV

 303 XSharp Bandol

1.7.2.3.7 -baseaddress

The -baseaddress option lets you specify the preferred base address at which to load a
DLL.

Syntax

-baseaddress:address

Arguments
address The base address for the DLL. This address can be specified as a
decimal, hexadecimal, or octal number.

Remarks
The default base address for a DLL is set by the .NET Framework common language
runtime.

Be aware that the lower-order word in this address will be rounded. For example, if you
specify 0x11110001, it will be rounded to 0x11110000.

To complete the signing process for a DLL, use SN.EXE with the -R option.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Add the option in the "User-Defined Command Line options" property

1.7.2.3.8 -checked

The -checked option specifies whether an integer arithmetic statement that results in a
value that is outside the range of the data type, and that is not in the scope of a checked or
unchecked keyword, causes a run-time exception.

Syntax

-checked[+ | -]

© 2015- 2019 XSharp BV

 X# Documentation 304

Remarks
An integer arithmetic statement that is in the scope of a checked or unchecked keyword is
not subject to the effect of The -checked option.

If an integer arithmetic statement that is not in the scope of a checked or unchecked

keyword results in a value outside the range of the data type, and -checked+ (/checked) is
used in the compilation, that statement causes an exception at run time. If -checked- is
used in the compilation, that statement does not cause an exception at run time.

The default value for this option is -checked-. One scenario for using -checked- is in
building large applications. Sometimes automated tools are used to build such
applications, and such a tool might automatically set -checked to +. You can override the
tool's global default by specifying -checked-.

The VO Compatibility compiler options -ovf and -fovf both set this option

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Add the option in the "User-Defined Command Line options" property

Example
The following command compiles t2.prg. The use of -checked in the command specifies
that any integer arithmetic statement in the file that is not in the scope of a checked or
unchecked keyword, and that results in a value that is outside the range of the data type,
causes an exception at run time.

xsc t2.prg -checked

1.7.2.3.9 -checksumalgorithm

Specify the algorithm for calculating the source file checksum stored in PDB. Supported
values are: SHA1 (default) or SHA256.

Syntax

-checksumalgorithm:<alg>

© 2015- 2019 XSharp BV

 305 XSharp Bandol

Arguments

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Add the option in the "User-Defined Command Line options" property

1.7.2.3.10 -codepage

This option specifies which codepage to use during compilation if the required page is not
the current default codepage for the system.

Syntax

-codepage:id

Arguments
id The id of the code page to use for all source code files in the
compilation.

Remarks
If you compile one or more source code files that were not created to use the default code
page on your computer, you can use The -codepage option to specify which code page
should be used. -codepage applies to all source code files in your compilation.

If the source code files were created with the same codepage that is in effect on your
computer or if the source code files were created with UNICODE or UTF-8, you need not
use -codepage.

See GetCPInfo for information on how to find which code pages are supported on your
system.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically.

1.7.2.3.11 -cs

The -cs option directs the compiler to treat all identifiers and type names as case-
sensitive.

This option is not supported yet in the current version of the compiler

© 2015- 2019 XSharp BV

 X# Documentation 306

Syntax

-cs[+|-]

Arguments
+|- Specifying +, or just -cs, directs the compiler to treat all type names as
case-sensitive.

Remarks
This option is for those users who prefer a case-sensitive language.

This option does not affect preprocessor symbols. The -vo8 compiler option controls
case-sensitivitiy in the preprocessor.

This option also does not affect keywords. Keywords in X# are always case-insensitive.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Language tab.
3. In the General section, modify the Case Sensitive Type Names property in the
General.

1.7.2.3.12 -debug

The -debug option causes the compiler to generate debugging information and place it in
the output file or files.

Syntax

-debug[+ | -]
-debug:{full | pdbonly}

Arguments
+ |- Specifying +, or just -debug, causes the compiler to generate
debugging information and place it in a program database (.pdb file).
Specifying -, which is in effect if you do not specify -debug, causes no
debug information to be created.

© 2015- 2019 XSharp BV

307 XSharp Bandol

full | pdbonly Specifies the type of debugging information generated by the compiler.
The full argument, which is in effect if you do not specify -
debug:pdbonly, enables attaching a debugger to the running program.
Specifying pdbonly allows source code debugging when the program
is started in the debugger but will only display assembler when the
running program is attached to the debugger.

Remarks
Use this option to create debug builds. If -debug, -debug+, or -debug:full is not specified,
you will not be able to debug the output file of your program.

If you use -debug:full, be aware that there is some impact on the speed and size of JIT
optimized code and a small impact on code quality with -debug:full. We recommend -
debug:pdbonly or no PDB for generating release code.

 Note
One difference between -debug:pdbonly and -debug:full is that with -debug:full the
compiler emits a DebuggableAttribute, which is used to tell the JIT compiler that debug
information is available. Therefore, you will get an error if your code contains the
DebuggableAttribute set to false if you use -debug:full.

For more information on how to configure the debug performance of an application, see
Making an Image Easier to Debug.

To change the location of the .pdb file, see -pdb

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Click the Advanced button.
4. Modify the Debug Info property.

For information on how to set this compiler option programmatically, see DebugSymbols.

Example
Place debugging information in output file app.pdb:

xsc -debug -pdb:app.pdb test.prg

© 2015- 2019 XSharp BV

 X# Documentation 308

1.7.2.3.13 -define

The -define compiler option defines name as a symbol in all source code files your
program.

Syntax

-define:name[;name2]

Arguments
name, name2 The name of one or more symbols that you want to define.

Remarks
The -define option has the same effect as using a #define preprocessor directive except
that the compiler option is in effect for all files in the project. A symbol remains defined in a
source file until an #undef directive in the source file removes the definition. When you use
The -define option, an #undef directive in one file has no effect on other source code files
in the project.

You can use symbols created by this option with #if, #else, #elif, and #endif to compile
source files conditionally.

-d is the short form of -define.

You can define multiple symbols with -define by using a semicolon or comma to separate
symbol names. For example:

-define:DEBUG;TUESDAY

The X# compiler defines a couple of symbols automatically. See the Macros topic
elsewhere in this documentation.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.
2. On the Build tab, type the symbol that is to be defined in the Conditional compilation
symbols box. For example, if you are using the code example that follows, just type
xx into the text box.

For information on how to set this compiler option programmatically, see

DefineConstants.

© 2015- 2019 XSharp BV

 309 XSharp Bandol

Example

-/ preprocessor_define.prg
-/ compile with: -define:xx
-/ or uncomment the next line
-/ #define xx
using System;
public class Test
{
public static void Main()
{
#if (xx)
Console.WriteLine("xx defined");
#else
Console.WriteLine("xx not defined");
#endif
}
}

1.7.2.3.14 -delaysign

This compiler option causes the compiler to reserve space in the output file so that a
digital signature can be added later.

Syntax

-delaysign[ + | - ]

Arguments
+ | - Use -delaysign- if you want a fully signed assembly. Use -delaysign+ if
you only want to place the public key in the assembly. The default is -
delaysign-.

Remarks
The -delaysign option has no effect unless used with -keyfile or -keycontainer.

When you request a fully signed assembly, the compiler hashes the file that contains the
manifest (assembly metadata) and signs that hash with the private key. The resulting
digital signature is stored in the file that contains the manifest. When an assembly is delay
signed, the compiler does not compute and store the signature, but reserves space in the
file so the signature can be added later.

© 2015- 2019 XSharp BV

 X# Documentation 310

For example, using -delaysign+ allows a tester to put the assembly in the global cache.
After testing, you can fully sign the assembly by placing the private key in the assembly
using the Assembly Linker utility.

For more information, see Creating and Using Strong-Named Assemblies and Delay
Signing an Assembly.

To set this compiler option in the Visual Studio development environment

1. Open the Properties page for the project.

2. Modify the Delay sign only property.

For information on how to set this compiler option programmatically, see DelaySign.

1.7.2.3.15 -dialect

The -dialect compiler option selects the dialect that the compiler should follow. Valid
options are: Core, VO, Vulcan, dBase, FoxPro, xBase++ and Harbour.

Syntax

-dialect: Core | VO | Vulcan

Arguments
Core Use the Core dialect. This is like C# with an xBase syntax.
VO This activates the VO dialect.
Vulcan This activates the Vulcan dialect.
Harbour This activates the Harbour dialect.
XBasePP This activates the Harbour dialect.

See the dialect topic for differences between dialects

1.7.2.3.16 -doc

The -doc compiler option allows you to place documentation comments in an XML file.

Syntax

-doc:file

Arguments

© 2015- 2019 XSharp BV

 311 XSharp Bandol

file The output file for XML, which is populated with the comments in the
source code files of the compilation.

Remarks
In source code files, documentation comments that precede the following can be
processed and added to the XML file:

· Such user-defined types as a class, delegate, or interface

· Such members as a field, event, property, or method

The source code file that contains Main is output first into the XML.

To use the generated .xml file for use with the IntelliSense feature, let the file name of the
.xml file be the same as the assembly you want to support and then make sure the .xml
file is in the same directory as the assembly. Thus, when the assembly is referenced in
the Visual Studio project, the .xml file is found as well. See Supplying Code Comments
and for more information.

Unless you compile with -target:module, file will contain <assembly></assembly> tags
specifying the name of the file containing the assembly manifest for the output file of the
compilation.

 
Note
The -doc option applies to all input files; or, if set in the Project Settings, all files in the
project. To disable warnings related to documentation comments for a specific file or
section of code, use #pragma warning.

See Recommended Tags for Documentation Comments for ways to generate

documentation from comments in your code.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build tab.
3. Modify the XML documentation file property.

For information on how to set this compiler option programmatically, see

DocumentationFile.

1.7.2.3.17 -errorendlocation

The -errorendlocation tells the compiler to Output the line and column of the end location
of each error in addition to the start location of the error/

Syntax

© 2015- 2019 XSharp BV

 X# Documentation 312

-errorendlocation

Remarks
This compiler option is unavailable in Visual Studio and cannot be changed
programmatically. It is enabled by default when compiling inside Visual Studio.

1.7.2.3.18 -errorreport

This compiler option provides a convenient way to report a X# internal compiler error

 Note
On Windows Vista and Windows Server 2008, the error reporting settings that you make
for Visual Studio do not override the settings made through Windows Error Reporting
(WER). WER settings always take precedence over Visual Studio error reporting settings.

Syntax

-errorreport:{ none | prompt | queue | send }

Arguments
none Reports about internal compiler errors will not be collected or sent to Microsoft.

prompt Prompts you to send a report when you receive an internal compiler
error. prompt is the default when you compile an application in the
development environment.

queue Queues the error report. When you log on with administrative
credentials, you can report any failures since the last time that you
were logged on. You will not be prompted to send reports for failures
more than once every three days. queue is the default when you
compile an application at the command line.

send Automatically sends reports of internal compiler errors to Microsoft. To

enable this option, you must first agree to the Microsoft data collection
policy. The first time that you specify -errorreport:send on a computer,
a compiler message will refer you to a Web site that contains the
Microsoft data collection policy.

Remarks

© 2015- 2019 XSharp BV

 313 XSharp Bandol

An internal compiler error (ICE) results when the compiler cannot process a source code
file. When an ICE occurs, the compiler does not produce an output file or any useful
diagnostic that you can use to fix your code.

A user's ability to send reports depends on computer and user policy permissions.

For more information about error debugger, see Description of the Dr. Watson for
Windows (Drwtsn32.exe) Tool.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Click the Advanced button.

1.7.2.3.19 -filealign

The -filealign compiler option lets you specify the size of sections in your output file.

Syntax

-filealign:number

Arguments
number A value that specifies the size of sections in the output file. Valid values
are 512, 1024, 2048, 4096, and 8192. These values are in bytes.

Remarks
Each section will be aligned on a boundary that is a multiple of The -filealign value. There
is no fixed default. If -filealign is not specified, the common language runtime picks a
default at compile time.

By specifying the section size, you affect the size of the output file. Modifying section size
may be useful for programs that will run on smaller devices.

Use DUMPBIN to see information about sections in your output file.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Add the option in the "User-Defined Command Line options" property

© 2015- 2019 XSharp BV

 X# Documentation 314

1.7.2.3.20 -fovf

The -fovf compiler option is an alias for the -checked command line option for compatibility
with Vulcan.

1.7.2.3.21 -fullpaths

The -fullpaths option causes the compiler to specify the full path to the file when listing
compilation errors and warnings.

Syntax

-fullpaths

Remarks
By default, errors and warnings that result from compilation specify the name of the file in
which an error was found. The -fullpaths option causes the compiler to specify the full
path to the file.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically. It is enabled by default when compiling inside Visual Studio.

1.7.2.3.22 -help, /?

This option sends a listing of compiler options, and a brief description of each option, to
stdout.

Syntax

-help
-?

Remarks
If this option is included in a compilation, no output file will be created and no compilation
will take place.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically.

© 2015- 2019 XSharp BV

 315 XSharp Bandol

1.7.2.3.23 -highentropyva

The -highentropyva compiler option tells the Windows kernel whether a particular
executable supports high entropy Address Space Layout Randomization (ASLR).

Syntax

-highentropyva[+ | -]

Arguments
+ | - This option specifies that a 64-bit executable or an executable that is
marked by The -platform:anycpu compiler option supports a high
entropy virtual address space. The option is disabled by default. Use -
highentropyva+ or -highentropyva to enable it.

Remarks
The -highentropyva option enables compatible versions of the Windows kernel to use
higher degrees of entropy when randomizing the address space layout of a process as
part of ASLR. Using higher degrees of entropy means that a larger number of addresses
can be allocated to memory regions such as stacks and heaps. As a result, it is more
difficult to guess the location of a particular memory region.

When The -highentropyva compiler option is specified, the target executable and any
modules that it depends on must be able to handle pointer values that are larger than 4
gigabytes (GB) when they are running as a 64-bit process.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Add the option in the "User-Defined Command Line options" property

1.7.2.3.24 -i

The -i option adds a directory to the list of directories the compiler searches for include
files.

Syntax

-i:dir

© 2015- 2019 XSharp BV

 X# Documentation 316

Arguments
dir A directory to add to list list of directories the compiler searches for
include files.

Remarks
The compiler searches for files included with #include in the following order:

1. The current working directory

2. The include subdirectory of the Vulcan.NET installation directory
3. The include subdirectory of the XSharp installation directory
4. Any directories specified with -i
5. Any directories specified with the INCLUDE environment variable

Multiple directories can be specified by using The -i option multiple times.

The compiler does not search for filenames that are fully qualified in any location other
than in the directory specified in the #include directive.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Build tab.
3. In the Preprocessor section, modify the "Additional include paths" property.

1.7.2.3.25 -ins

The -ins option specifies whether the compiler should automatically include namespaces
from Vulcan Assemblies or X# assemblies compiled in VO/Vulcan dialect marked with
the VulcanImplicitNameSpaceAttribute (Vulcan runtime) or ImplicitNameSpaceAttribute
(X# runtime).

Syntax

-ins[+|-]

Arguments
+ | - Specifying +, or just -ins, directs the compiler to automatically include
namespaces from assemblies marked with the
VulcanImplicitNameSpaceAttribute.

Remarks

© 2015- 2019 XSharp BV

 317 XSharp Bandol

Class Libraries can be compiled with a special attribute:

[assembly: VulcanImplicitNamespaceAttribute( "SomeNameSpace )]

This attribute tells the compiler that classes that are placed inside that namespace should
be automatically included when searching for classes, as if there was a #using
SomeNameSpace statement in the source code.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Language tab.
3. In the Namespaces section, modify the Enable Implicit Lookup of Namespaces
property.

Example
The following example will compile when The -ins switch is used and the
VulcanVOGUIClasses assembly is included. Without -ins, errors will be raised.

Note that the App class and ShellWindow class are located in the Vulcan.VO namespace

If The -ins option is enabled, then the above example will be compiled as if it was written:

1.7.2.3.26 -keycontainer

Specifies the name of the cryptographic key container.

Syntax

-keycontainer:string

© 2015- 2019 XSharp BV

 X# Documentation 318

Arguments
string The name of the strong name key container.

Remarks
When The -keycontainer option is used, the compiler creates a sharable component by
inserting a public key from the specified container into the assembly manifest and signing
the final assembly with the private key. To generate a key file, type sn -k file at the
command line. sn -i installs the key pair into a container.

If you compile with -target:module, the name of the key file is held in the module and
incorporated into the assembly when you compile this module into an assembly with -
addmodule.

You can also specify this option as a custom attribute

(System.Reflection.AssemblyKeyNameAttribute) in the source code for any Microsoft
intermediate language (MSIL) module.

You can also pass your encryption information to the compiler with -keyfile. Use -delaysign
if you want the public key added to the assembly manifest but want to delay signing the
assembly until it has been tested.

For more information, see Creating and Using Strong-Named Assemblies and Delay
Signing an Assembly.

To set this compiler option in the Visual Studio development environment

1. This compiler option is not available in the Visual Studio development environment.

You can programmatically access this compiler option with AssemblyKeyContainerName.

1.7.2.3.27 -keyfile

Specifies the filename containing the cryptographic key.

Syntax

-keyfile:file

Arguments
file The name of the file containing the strong name key.

Remarks

© 2015- 2019 XSharp BV

 319 XSharp Bandol

When this option is used, the compiler inserts the public key from the specified file into the
assembly manifest and then signs the final assembly with the private key. To generate a
key file, type sn -k file at the command line.

If you compile with -target:module, the name of the key file is held in the module and
incorporated into the assembly that is created when you compile an assembly with -
addmodule.

You can also pass your encryption information to the compiler with -keycontainer. Use -
delaysign if you want a partially signed assembly.

In case both -keyfile and -keycontainer are specified (either by command line option or by
custom attribute) in the same compilation, the compiler will first try the key container. If
that succeeds, then the assembly is signed with the information in the key container. If the
compiler does not find the key container, it will try the file specified with -keyfile. If that
succeeds, the assembly is signed with the information in the key file and the key
information will be installed in the key container (similar to sn -i) so that on the next
compilation, the key container will be valid.

Note that a key file might contain only the public key.

For more information, see Creating and Using Strong-Named Assemblies and Delay
Signing an Assembly.

To set this compiler option in the Visual Studio development environment

1. Open the Properties page for the project.
2. Click the Signing property page.
3. Modify the Choose a strong name key file property.

You can programmatically access this compiler option with AssemblyOriginatorKeyFile.

1.7.2.3.28 -langversion

this compiler option is ignored. When compared to the C# compiler, X# always compiles
in the languageversion Latest.

1.7.2.3.29 -lb

The -lb option specifies if the compiler should allow code that uses the Late Binding
mechnism to call methods and or get/set properties

Syntax

-lb[+|-]

Arguments
+ | - Specifying +, or just -lb, directs the compiler to generate a late-bound
call to an instance variable or method when compiler cannot generate
code for an early bound call.

© 2015- 2019 XSharp BV

 X# Documentation 320

Remarks
The X# compiler always attempts to generate early bound calls to all class methods,
properties and fields. This is true even for methods referred to as "untyped" in Visual
Objects. Strictly speaking, nothing is "untyped". If an early bound call cannot be generated,
a compile-time error is raised.

In Visual Objects, it is possible to invoke methods and access instance variables on an

object without the compiler knowing the exact type of the object. This is done by using a
variable of type OBJECT or USUAL to hold the object reference. The "Only Early" option in
the VO Application Options dialog must not be checked in order to allow this.

In addition, it is also possible to invoke a method on each element of an ARRAY. Each

array element must contain an object that implements the specified method, or a runtime
error will occur.

The -lb option is the exact opposite of the Visual Objects Only Early option.

Late binding incurs considerably more runtime overhead than early binding, and prevents
compile-time parameter and return value checking. Any late-bound call has the potential to
fail at runtime if the object does not support the field or property that is being accessed,
the member being invoked or incorrect parameter types or count. Only use early binding
for existing code or when there is no viable alternative.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the Allow Late Binding property.

Example
The following example will compile when The -lb switch is used. Without -lb, errors will be
raised.

Note that using late-bound calls can affect the performance of an application and raises
the possibility of runtime errors that would otherwise be caught by the compiler if early
binding was used. Late binding should only be used for compatibility with existing VO
code.

If The -lb option is enabled, then the above example will be compiled as if it was written:

© 2015- 2019 XSharp BV

 321 XSharp Bandol

Note that while this particular example will compile and execute correctly, if the definition
of CLASS foo was changed and INSTANCE i was removed or changed to a method, the
example would fail at runtime. Similarly, if METHOD bar was changed or removed, the
example may also fail at runtime. For this reason, late-bound programming is strongly
discouraged. Consider using subclassing and inheritance instead.

1.7.2.3.30 -lib

The -lib option specifies the location of assemblies referenced by means of the -reference
option.

Syntax

-lib:dir1[,dir2]

Arguments
dir1 A directory for the compiler to look in if a referenced assembly is not
found in the current working directory (the directory from which you are
invoking the compiler) or in the common language runtime's system
directory.
dir2 One or more additional directories to search in for assembly
references. Separate additional directory names with a comma, and
without white space between them.

Remarks
The compiler searches for assembly references that are not fully qualified in the following
order:
1. Current working directory. This is the directory from which the compiler is invoked.
2. The common language runtime system directory.
3. Directories specified by -lib.
4. Directories specified by the LIB environment variable.

Use -reference to specify an assembly reference.

-lib is additive; specifying it more than once appends to any prior values.

An alternative to using -lib is to copy into the working directory any required assemblies;
this will allow you to simply pass the assembly name to -reference. You can then delete
the assemblies from the working directory. Since the path to the dependent assembly is
not specified in the assembly manifest, the application can be started on the target
computer and will find and use the assembly in the global assembly cache.

© 2015- 2019 XSharp BV

 X# Documentation 322

Because the compiler can reference the assembly does not imply the common language
runtime will be able to find and load the assembly at runtime. See How the Runtime
Locates Assemblies for details on how the runtime searches for referenced assemblies.

To set this compiler option in the Visual Studio development environment

1. Open the project's Property Pages dialog box.
2. Click the References Path property page.
3. Modify the contents of the list box.

For information on how to set this compiler option programmatically, see ReferencePath.

Example
Compile t2.prg to create an .exe file. The compiler will look in the working directory and in
the root directory of the C drive for assembly references.

xsc -lib:c:\ -reference:t2.dll t2.prg

1.7.2.3.31 -link

Causes the compiler to make COM type information in the specified assemblies available
to the project that you are currently compiling.

Syntax

-link:fileList
-/ -or-
-l:fileList

Arguments
fileList Required. Comma-delimited list of assembly file names. If the file
name contains a space, enclose the name in quotation marks.

Remarks
The -link option enables you to deploy an application that has embedded type
information. The application can then use types in a runtime assembly that implement the
embedded type information without requiring a reference to the runtime assembly. If
various versions of the runtime assembly are published, the application that contains the
embedded type information can work with the various versions without having to be
recompiled. For an example, see Walkthrough: Embedding Types from Managed
Assemblies.

© 2015- 2019 XSharp BV

323 XSharp Bandol

Using The -link option is especially useful when you are working with COM interop. You
can embed COM types so that your application no longer requires a primary interop
assembly (PIA) on the target computer. The -link option instructs the compiler to embed
the COM type information from the referenced interop assembly into the resulting
compiled code. The COM type is identified by the CLSID (GUID) value. As a result, your
application can run on a target computer that has installed the same COM types with the
same CLSID values. Applications that automate Microsoft Office are a good example.
Because applications like Office usually keep the same CLSID value across different
versions, your application can use the referenced COM types as long as .NET Framework
4 or later is installed on the target computer and your application uses methods,
properties, or events that are included in the referenced COM types.

The -link option embeds only interfaces, structures, and delegates. Embedding COM
classes is not supported.

Note
When you create an instance of an embedded COM type in your code, you must create
the instance by using the appropriate interface. Attempting to create an instance of an
embedded COM type by using the CoClass causes an error.

To set the -link option in Visual Studio, add an assembly reference and set the Embed
Interop Types property to true. The default for the Embed Interop Types property is false.

If you link to a COM assembly (Assembly A) which itself references another COM
assembly (Assembly B), you also have to link to Assembly B if either of the following is
true:
· A type from Assembly A inherits from a type or implements an interface from
Assembly B.
· A field, property, event, or method that has a return type or parameter type from
Assembly B is invoked.

Like The -reference compiler option, the -link compiler option uses the xsc.rsp response
file, which references frequently used .NET Framework assemblies. Use The -noconfig
compiler option if you do not want the compiler to use the xsc.rsp file.

The short form of -link is -l.

Generics and Embedded Types

The following sections describe the limitations on using generic types in applications that
embed interop types.

Generic Interfaces
Generic interfaces that are embedded from an interop assembly cannot be used.

Types That Have Generic Parameters

Types that have a generic parameter whose type is embedded from an interop assembly
cannot be used if that type is from an external assembly. This restriction does not apply to
interfaces. For example, consider the Range interface that is defined in the
Microsoft.Office.Interop.Excel assembly. If a library embeds interop types from the
Microsoft.Office.Interop.Excel assembly and exposes a method that returns a generic type

© 2015- 2019 XSharp BV

 X# Documentation 324

that has a parameter whose type is the Range interface, that method must return a
generic interface, as shown in the following code example.

Example
The following code compiles source file OfficeApp.prg and reference assemblies from
COMData1.dll and COMData2.dll to produce OfficeApp.exe.

xsc -link:COMData1.dll,COMData2.dll -out:OfficeApp.exe OfficeApp.prg

1.7.2.3.32 -linkresource

Creates a link to a .NET Framework resource in the output file. The resource file is not
added to the output file. This differs from The -resource option which does embed a
resource file in the output file.

Syntax

-linkresource:filename[,identifier[,accessibility-modifier]]

Arguments
filename The .NET Framework resource file to which you want to link from the
assembly.
identifier (optional) The logical name for the resource; the name that is used to load the
resource. The default is the name of the file.
accessibility-modifier
(optional) The accessibility of the resource: public or private. The default is
public.
Remarks
By default, linked resources are public in the assembly when they are created with the X#
compiler. To make the resources private, specify private as the accessibility modifier. No
other modifier other than public or private is allowed.

-linkresource requires one of The -target options other than -target:module.

If filename is a .NET Framework resource file created, for example, by Resgen.exe or in

the development environment, it can be accessed with members in the
System.Resources namespace. For more information, see
System.Resources.ResourceManager. For all other resources, use the
GetManifestResource* methods in the Assembly class to access the resource at run time.

The file specified in filename can be any format. For example, you may want to make a
native DLL part of the assembly, so that it can be installed into the global assembly cache

© 2015- 2019 XSharp BV

325 XSharp Bandol

and accessed from managed code in the assembly. The second of the following
examples shows how to do this. You can do the same thing in the Assembly Linker. The
third of the following examples shows how to do this. For more information, see Al.exe
(Assembly Linker) and Working with Assemblies and the Global Assembly Cache
.
-linkres is the short form of -linkresource.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically.

Example
Compile in.prg and link to resource file rf.resource:

xsc -linkresource:rf.resource in.prg

Example
Compile A.prg into a DLL, link to a native DLL N.dll, and put the output in the Global
Assembly Cache (GAC). In this example, both A.dll and N.dll will reside in the GAC.

xsc -linkresource:N.dll -t:library A.prg

gacutil -i A.dll

Example
This example does the same thing as the previous one, but by using Assembly Linker
options.

xsc -t:module A.prg

al -out:A.dll A.netmodule -link:N.dll
gacutil -i A.dll

© 2015- 2019 XSharp BV

 X# Documentation 326

1.7.2.3.33 -main

This option specifies the class that contains the entry point to the program, if more than
one class contains a Main method.

Syntax

-main:class

Arguments
class The type that contains the Main method.

Remarks
If your compilation includes more than one type with a Main method, you can specify
which type contains the Main method that you want to use as the entry point into the
program.

This option is for use when compiling an .exe file.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.
2. Click the Application property page.
3. Modify the Startup object property.

To set this compiler option programmatically, see StartupObject.

Example

Compile t2.prg and t3.prg, specifying that the Main method will be found in Test2:

xsc t2.prg t3.prg -main:Test2

1.7.2.3.34 -memvar

The -memvar option tells the compiler to enable the support for 'memory variables'

Syntax

© 2015- 2019 XSharp BV

 327 XSharp Bandol

-memvar [+ | -]

Arguments
+ |- Specifying +, or just -memvar, directs the compiler to enable support
for memory variables.

Remarks
This will NOT work with the Core and Vulcan dialects.
Enabling this option will enable the following commands in the compiler:

MEMVAR <MemvarName,...>
PUBLIC <MemVarName,...>
PRIVATE <MemVarName,...>
PARAMETERS <ParameterName,,...>

1.7.2.3.35 -moduleassemblyname

Specifies an assembly whose non-public types a .netmodule can access.

Syntax

-moduleassemblyname:assembly_name

Arguments
assembly_name The name of the assembly whose non-public types the .netmodule
can access.

Remarks
-moduleassemblyname should be used when building a .netmodule, and where the
following conditions are true:

· The .netmodule needs access to non-public types in an existing assembly.

· You know the name of the assembly into which the .netmodule will be built.
· The existing assembly has granted friend assembly access to the assembly into
which the .netmodule will be built.

For more information on building a .netmodule, see -target:module.

For more information on friend assemblies, see Friend Assemblies.

© 2015- 2019 XSharp BV

 X# Documentation 328

This option is not available from within the development environment; it is only available
when compiling from the command line.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically.

Example
This sample builds an assembly with a private type, and that gives friend assembly
access to an assembly called csman_an_assembly.

-/ moduleassemblyname_1.prg
-/ compile with: -target:library
using System;
using System.Runtime.CompilerServices;

[assembly:InternalsVisibleTo ("csman_an_assembly")]

class An_Internal_Class

{
public void Test()
{

Console.WriteLine("An_Internal_Class.Test called");
}
}

Example
This sample builds a .netmodule that accesses a non-public type in the assembly
moduleassemblyname_1.dll. By knowing that this .netmodule will be built into an
assembly called csman_an_assembly, we can specify -moduleassemblyname, allowing
the .netmodule to access non-public types in an assembly that has granted friend
assembly access to csman_an_assembly.

-/ moduleassemblyname_2.prg
-/ compile with: -moduleassemblyname:csman_an_assembly -target:module -
reference:moduleassemblyname_1.dll
class B {
public void Test() {
An_Internal_Class x = new An_Internal_Class();
x.Test();

© 2015- 2019 XSharp BV

 329 XSharp Bandol

}
}

Example
This code sample builds the assembly csman_an_assembly, referencing the previously-
built assembly and .netmodule.

-/ csman_an_assembly.prg
-/ compile with: -addmodule:moduleassemblyname_2.netmodule -
reference:moduleassemblyname_1.dll
class A {
public static void Main() {
B bb = new B();
bb.Test();
}
}

1.7.2.3.36 -modulename:<string>

Specify the name of the source module

1.7.2.3.37 -namedargs

Specifies whether to allow named arguments in the parser or not.

Syntax

-namedargs [+ | -]

Arguments
+ |- Specifying +, or just -namedargs, directs the compiler to allow
namedarguments. Specifying - directs the compiler to NOT use
named arguments

Remarks
The default = + for the Core dialect and - for all other dialects. So -namedargs- only is
useful in combination with the Core dialect.

© 2015- 2019 XSharp BV

 X# Documentation 330

Note If you enable this option then quite often existing code such as the code below will
produce compiler errors>
That is why we have disabled named arguments for most dialects.

FUNCTION Start as VOID

LOCAL a AS ARRAY
-/ When named arguments are enabled then the compiler will complain that
there is no parameter named "a" for the Empty function
IF !Empty( a := SomeFunctionThatReturnsAnArray())
-/ do something
ENDIF
RETURN

1.7.2.3.38 -noconfig

The -noconfig option tells the compiler not to compile with the xsc.rsp file, which is located
in and loaded from the same directory as the xsc.exe file.

Syntax

-noconfig

Remarks
The xsc.rsp file references all the assemblies shipped with the .NET Framework. The
actual references that the Visual Studio .NET development environment includes depend
on the project type.

You can modify the xsc.rsp file and specify additional compiler options that should be
included in every compilation from the command line with xsc.exe (except The -noconfig
option).

The compiler processes the options passed to the xsc command last. Therefore, any
option on the command line overrides the setting of the same option in the xsc.rsp file.

If you do not want the compiler to look for and use the settings in the xsc.rsp file, specify -
noconfig.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically.

1.7.2.3.39 -nologo

The -nologo option suppresses display of the sign-on banner when the compiler starts up
and display of informational messages during compiling.

Syntax

© 2015- 2019 XSharp BV

 331 XSharp Bandol

-nologo

Remarks
This option is not available from within the development environment; it is only available
when compiling from the command line.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically.

1.7.2.3.40 -nostddefs

The -nostddefs option prevents the compiler from using the preprocessor directives in
XSharpDefs.xh.

Syntax

-nostddefs[+|-]

Arguments
+ |- Specifying +, or just -nostddefs, prevents the compiler from using the
preprocessor directives in XSharpDefs.xh.

Remarks

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Build tab.
3. In the Preprocessor section, modify the "Suppress standard header file" property.

1.7.2.3.41 -nostdlib

-nostdlib prevents the import of mscorlib.dll, which defines the entire System namespace.

Syntax

-nostdlib[+ | -]

© 2015- 2019 XSharp BV

 X# Documentation 332

Remarks
Use this option if you want to define or create your own System namespace and objects.

If you do not specify -nostdlib, mscorlib.dll will be imported into your program (same as
specifying -nostdlib-). Specifying -nostdlib is the same as specifying -nostdlib+.

To set this compiler option in the Visual Studio development environment

1. Open the Properties page for the project.

2. Click the Build properties page.
3. Add the option in the "User-Defined Command Line options" property

1.7.2.3.42 -now arn

The -nowarn option lets you suppress the compiler from displaying one or more warnings.
Separate multiple warning numbers with a comma.

Syntax

-nowarn:number1[,number2,...]

Arguments
number1, number2 Warning number(s) that you want the compiler to suppress.

Remarks
You should only specify the numeric part of the warning identifier. For example, if you want
to suppress XS0028, you could specify -nowarn:28.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.
2. Click the Build property page.
3. Modify the "Suppress Specific Warnings" property.

1.7.2.3.43 -now in32manifest

Use The -nowin32manifest option to instruct the compiler not to embed any application
manifest into the executable file.

Syntax

© 2015- 2019 XSharp BV

 333 XSharp Bandol

-nowin32manifest

Remarks
When this option is used, the application will be subject to virtualization on Windows Vista
unless you provide an application manifest in a Win32 Resource file or during a later build
step.

1.7.2.3.44 -ns

The -ns option explicitly specifies the default namespace for all types that do not have an
explicit namespace in their name.

Syntax

-ns[: ]namespaceName

Arguments
namespaceName The name of the default namespace for all types declared in the
application or class library.

Remarks
If The -ns option is not specified, then types that are not prefixed with a namespace and
types that are not in a BEGIN NAMESPACE .. END NAMESPACE construct will be
compiled as so-called global types.

The -ns option will work on the following types:

· Classes
· Interfaces
· Structures
· Vostructs
· Delegates

Namespace names must follow the same rules for program identifiers: they must begin
with an uppercase or lowercase letter or an underscore, followed by zero or more
uppercase or lowercase letters, numbers or underscores. All other characters are illegal,
and will raise a compile-time error.

The default namespace is used for any declared types that do not have an explicit
namespace in their name.

© 2015- 2019 XSharp BV

 X# Documentation 334

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the General tab.
3. In the Application section, modify the Default Namespace property.
4. Click the Language tab
5. In the Namespaces section, modify the Prefix classes with Default Namespace
property.

Example
When the following code is compiled without -ns compiler option the following types will be
produced:

· Customer
· Point
· MyProject.Customer
· MyProject.Data.Customer

CLASS Customer
.
.
END CLASS

STRUCT Point
.
.
END STRUCT

ENUM CustomerType
.
END ENUM

CLASS MyProject.Customer
.
.
END CLASS

BEGIN NAMESPACE MyProject.Data

CLASS Customer
.
.
END CLASS
END NAMESPACE

If you compile the same code with a -ns:MyNameSpace option the following types will be
produced:

© 2015- 2019 XSharp BV

 335 XSharp Bandol

· MyNameSpace.Customer
· MyNameSpace.Point
· MyProject.Customer
· MyProject.Data.Customer

1.7.2.3.45 -optimize

The -optimize option enables or disables optimizations performed by the compiler to make
your output file smaller, faster, and more efficient.

Syntax

-optimize[+ | -]

Remarks
-optimize also tells the common language runtime to optimize code at runtime.

By default, optimizations are disabled. Specify -optimize+ to enable optimizations.

When building a module to be used by an assembly, use the same -optimize settings as
those of the assembly.

-o is the short form of -optimize.

It is possible to combine The -optimize and -debug options.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Modify the "Optimize" property.

Example
Compile t2.prg and enable compiler optimizations:

xsc t2.prg -optimize

© 2015- 2019 XSharp BV

 X# Documentation 336

1.7.2.3.46 -out

The -out option specifies the name of the output file.

Syntax

-out:filename

Arguments
filename The name of the output file created by the compiler.

Remarks
On the command line, it is possible to specify multiple output files for your compilation.
The compiler expects to find one or more source code files following The -out option.
Then, all source code files will be compiled into the output file specified by that -out option.

Specify the full name and extension of the file you want to create.

If you do not specify the name of the output file:

· An .exe will take its name from the source code file that contains the Main method.
· A .dll or .netmodule will take its name from the first source code file.

A source code file used to compile one output file cannot be used in the same compilation
for the compilation of another output file.

When producing multiple output files in a command-line compilation, keep in mind that
only one of the output files can be an assembly and that only the first output file specified
(implicitly or explicitly with -out) can be the assembly.

Any modules produced as part of a compilation become files associated with any
assembly also produced in the compilation. Use ildasm.exe to view the assembly
manifest to see the associated files.

The -out compiler option is required in order for an exe to be the target of a friend
assembly.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Application property page.
3. Modify the Assembly name property.

To set this compiler option programmatically: the OutputFileName is a read-only property,

which is determined by a combination of the project type (exe, library, and so forth) and

© 2015- 2019 XSharp BV

 337 XSharp Bandol

the assembly name. Modifying one or both of these properties will be necessary to set the
output file name.

Example
Compile t.prg and create output file t.exe, as well as build t2.prg and create module
output file mymodule.netmodule:

xsc t.prg -out:mymodule.netmodule -target:module t2.prg

1.7.2.3.47 -ovf

The -ovf compiler option is an alias for the -checked command line option for compatibility
with Vulcan.

1.7.2.3.48 -parallel

Specifies whether to use concurrent build (+).

1.7.2.3.49 -pathmap

Specify a mapping for source path names output by the compiler.

Syntax

-pathmap:path1=sourcePath1,path2=sourcePath2

Arguments
path1 The full path to the source files in the current environment
sourcePath1 The source path substituted for path1 in any output files.

To specify multiple mapped source paths, separate each with a comma.

Remarks
The compiler writes the source path into its output for the following reasons:
1. The source path is substituted for an argument when the CallerFilePathAttribute is
applied to an optional parameter.
2. The source path is embedded in a PDB file.
3. The path of the PDB file is embedded into a PE (portable executable) file.

© 2015- 2019 XSharp BV

 X# Documentation 338

This option maps each physical path on the machine where the compiler runs to a
corresponding path that should be written in the output files.

1.7.2.3.50 -pdb

The -pdb compiler option specifies the name and location of the debug symbols file.

Syntax

-pdb:filename

Arguments
filename The name and location of the debug symbols file.

Remarks
When you specify -debug , the compiler will create a .pdb file in the same directory where
the compiler will create the output file (.exe or .dll) with a file name that is the same as the
name of the output file.

-pdb allows you to specify a non-default file name and location for the .pdb file.

This compiler option cannot be set in the Visual Studio development environment, nor can
it be changed programmatically.

Example
Compile t.prg and create a .pdb file called tt.pdb:

xsc -debug -pdb:tt t.prg

1.7.2.3.51 -platform

Specifies which version of the common language runtime (CLR) can run the assembly.

Syntax

-platform:string

© 2015- 2019 XSharp BV

339 XSharp Bandol

Arguments
string anycpu (default), anycpu32bitpreferred, ARM, x64, x86, or Itanium.

Remarks
· anycpu (default) compiles your assembly to run on any platform. Your application runs
as a 64-bit process whenever possible and falls back to 32-bit when only that mode is
available.
· anycpu32bitpreferred compiles your assembly to run on any platform. Your application
runs in 32-bit mode on systems that support both 64-bit and 32-bit applications. You
can specify this option only for projects that target the .NET Framework 4.5.
· ARM compiles your assembly to run on a computer that has an Advanced RISC
Machine (ARM) processor.
· x64 compiles your assembly to be run by the 64-bit common language runtime on a
computer that supports the AMD64 or EM64T instruction set.
· x86 compiles your assembly to be run by the 32-bit, x86-compatible common
language runtime.
· Itanium compiles your assembly to be run by the 64-bit common language runtime on
a computer with an Itanium processor.

On a 64-bit Windows operating system:

· Assemblies compiled with -platform:x86 execute on the 32-bit CLR running under
WOW64.
· A DLL compiled with The -platform:anycpu executes on the same CLR as the
process into which it is loaded.
· Executables that are compiled with The -platform:anycpu execute on the 64-bit CLR.
· Executables compiled with -platform:anycpu32bitpreferred execute on the 32-bit CLR.

The anycpu32bitpreferred setting is valid only for executable (.EXE) files, and it requires
the .NET Framework 4.5.

To set this compiler option in the Visual Studio development environment

1. Open the Properties page for the project.

2. Click the General property page.
3. Modify the Platform target property and, for projects that target the .NET Framework
4.5, select or clear the Prefer 32-bit check box.

Example
The following example shows how to use The -platform option to specify that the
application should be run by the 64-bit CLR on a 64-bit Windows operating system.

xsc -platform:anycpu filename.prg

© 2015- 2019 XSharp BV

 X# Documentation 340

1.7.2.3.52 -ppo

The -ppo option directs the compiler to write the output of the preprocessor to a file.

Syntax

-ppo [+ | -]

Arguments
+ |- Specifying +, or just -ppo, directs the compiler to write the output of the
preprocessor to a file.
When ppo is not enabled then the compiler will delete any existing ppo
files that match input file names

Remarks
Each source file will be written to a file with the same base name and an extension of
.ppo, in the same directory as the source file. If a .ppo file already exists, it will be
overwritten without warning.

Tip:
.ppo files can be viewed within Visual Studio. After enabling The -ppo option and rebuilding
the project, select any node in the project in Solution Explorer, click the Show All Files
button in the Solution Explorer toolbar, then double click the desired .ppo file node.

To view a .prg and .ppo file side-by-side to compare them, right click the document tab in
either the .prg or .ppo file and click New Vertical Tab Group.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page (see How to: Set Build Properties).
2. Click the Build tab.
3. In the Preprocessor section, modify the "Generate preprocessor output"property.

1.7.2.3.53 -preferreduilang

By using The -preferreduilang compiler option, you can specify the language in which the
X# compiler displays output, such as error messages.

Syntax

© 2015- 2019 XSharp BV

 341 XSharp Bandol

-preferreduilang: language

Arguments
language The language name of the language to use for compiler output.

Remarks
The preferreduilang compiler option is recognized but ignored. The X# compiler only
works in the english language (for now ?)

1.7.2.3.54 -recurse

The -recurse option enables you to compile source code files in all child directories of
either the specified directory (dir) or of the project directory.

Syntax

-recurse:[dir\]file

Arguments
dir (optional) The directory in which you want the search to begin. If this is not
specified, the search begins in the project directory.
file The file(s) to search for. Wildcard characters are allowed.

Remarks
The -recurse option lets you compile source code files in all child directories of either the
specified directory (dir) or of the project directory.
You can use wildcards in a file name to compile all matching files in the project directory
without using -recurse.
This compiler option is unavailable in Visual Studio and cannot be changed
programmatically.

Example
Compiles all X# files in the current directory:

© 2015- 2019 XSharp BV

 X# Documentation 342

xsc *.prg

Compiles all of the X# files in the dir1\dir2 directory and any directories below it and
generates dir2.dll:

xsc -target:library -out:dir2.dll -recurse:dir1\dir2\*.prg

1.7.2.3.55 -reference

The -reference option causes the compiler to import public type information in the
specified file into the current project, thus enabling you to reference metadata from the
specified assembly files.

Syntax

-reference:[alias=]filename
-reference:filename

Arguments
filename The name of a file that contains an assembly manifest. To import
more than one file, include a separate -reference option for each file.
alias A valid X# identifier that will represent a root namespace that will
contain all namespaces in the assembly.

Remarks
To import from more than one file, include a -reference option for each file.

The files you import must contain a manifest; the output file must have been compiled with
one of The -target options other than -target:module.

-r is the short form of -reference.

Use -addmodule to import metadata from an output file that does not contain an assembly
manifest.

If you reference an assembly (Assembly A) that references another assembly (Assembly

B), you will need to reference Assembly B if:

© 2015- 2019 XSharp BV

343 XSharp Bandol

· A type you use from Assembly A inherits from a type or implements an interface from
Assembly B.
· You invoke a field, property, event, or method that has a return type or parameter type
from Assembly B.

Use -lib to specify the directory in which one or more of your assembly references is
located. The -lib topic also discusses the directories in which the compiler searches for
assemblies.

In order for the compiler to recognize a type in an assembly, and not in a module, it needs
to be forced to resolve the type, which you can do by defining an instance of the type.
There are other ways to resolve type names in an assembly for the compiler: for example,
if you inherit from a type in an assembly, the type name will then be recognized by the
compiler.

Sometimes it is necessary to reference two different versions of the same component

from within one assembly. To do this, use the alias suboption on The -reference switch for
each file to distinguish between the two files. This alias will be used as a qualifier for the
component name, and will resolve to the component in one of the files.

The xsc response (.rsp) file, which references commonly used .NET Framework
assemblies, is used by default. Use -noconfig if you do not want the compiler to use
xsc.rsp.

Note
In Visual Studio, use the Add Reference dialog box.

Example
This example shows how to use the extern alias feature.

You compile the source file and import metadata from grid.dll and grid20.dll,which
have been compiled previously. The two DLLs contain separate versions of the same
component, and you use two -reference with alias options to compile the source file. The
options look like this:

-reference:GridV1=grid.dll and -reference:GridV2=grid20.dll

This sets up the external aliases "GridV1" and "GridV2," which you use in your program by
means of an extern statement:

extern alias GridV1;

extern alias GridV2;
-/ Using statements go here.

© 2015- 2019 XSharp BV

 X# Documentation 344

Once this is done, you can refer to the grid control from grid.dll by prefixing the control
name with GridV1, like this:

GridV1::Grid

In addition, you can refer to the grid control from grid20.dll by prefixing the control name
with GridV2 like this:

GridV2::Grid

1.7.2.3.56 -refonly

The -refonly option indicates that a reference assembly should be output instead of an
implementation assembly, as the primary output. The -refonly parameter silently disables
outputting PDBs, as reference assemblies cannot be executed.

Syntax

-refonly

Metadata-only assemblies have their method bodies replaced with a single throw null
body, but include all members except anonymous types. The reason for using throw null
bodies (as opposed to no bodies) is so that PEVerify could run and pass (thus validating
the completeness of the metadata).
Reference assemblies include an assembly-level ReferenceAssembly attribute. This
attribute may be specified in source (then the compiler won't need to synthesize it).
Because of this attribute, runtimes will refuse to load reference assemblies for execution
(but they can still be loaded in reflection-only mode). Tools that reflect on assemblies need
to ensure they load reference assemblies as reflection-only, otherwise they will receive a
typeload error from the runtime.
Reference assemblies further remove metadata (private members) from metadata-only
assemblies:
· A reference assembly only has references for what it needs in the API surface. The real
assembly may have additional references related to specific implementations.
· Private function-members (methods, properties, and events) are removed in cases
where their removal doesn't observably impact compilation. If there are no
InternalsVisibleTo attributes, do the same for internal function-members.
· But all types (including private or nested types) are kept in reference assemblies. All
attributes are kept (even internal ones).
· All virtual methods are kept. Explicit interface implementations are kept. Explicitly
implemented properties and events are kept, as their accessors are virtual (and are
therefore kept).

© 2015- 2019 XSharp BV

 345 XSharp Bandol

· All fields of a struct are kept. (This is a candidate for post-C#-7.1 refinement)
The -refonly and -refout options are mutually exclusive.

1.7.2.3.57 -refout

The -refout option specifies a file path where the reference assembly should be output.
This translates to metadataPeStream in the Emit API.

Syntax

-refout:filepath

Arguments
filepath The name and path of the output file created by the compiler.

Remarks
The filename should generally match that of the primary assembly. The recommended
convention (used by MSBuild) is to place the reference assembly in a "ref/" sub-folder
relative to the primary assembly.

Metadata-only assemblies have their method bodies replaced with a single throw null
body, but include all members except anonymous types. The reason for using throw null
bodies (as opposed to no bodies) is so that PEVerify could run and pass (thus validating
the completeness of the metadata).
Reference assemblies include an assembly-level ReferenceAssembly attribute. This
attribute may be specified in source (then the compiler won't need to synthesize it).
Because of this attribute, runtimes will refuse to load reference assemblies for execution
(but they can still be loaded in reflection-only mode). Tools that reflect on assemblies need
to ensure they load reference assemblies as reflection-only, otherwise they will receive a
typeload error from the runtime.
Reference assemblies further remove metadata (private members) from metadata-only
assemblies:
· A reference assembly only has references for what it needs in the API surface. The real
assembly may have additional references related to specific implementations.
· Private function-members (methods, properties, and events) are removed in cases
where their removal doesn't observably impact compilation. If there are no
InternalsVisibleTo attributes, do the same for internal function-members.
· But all types (including private or nested types) are kept in reference assemblies. All
attributes are kept (even internal ones).
· All virtual methods are kept. Explicit interface implementations are kept. Explicitly
implemented properties and events are kept, as their accessors are virtual (and are
therefore kept).
· All fields of a struct are kept.
The -refout and -refonly options are mutually exclusive.

© 2015- 2019 XSharp BV

 X# Documentation 346

1.7.2.3.58 -resource

Embeds the specified resource into the output file.

Syntax

-resource:filename[,identifier[,accessibility-modifier]]

Arguments
filename The .NET Framework resource file that you want to embed in the
output file.

identifier (optional) The logical name for the resource; the name that is used to load the
resource. The default is the name of the file name.

accessibility-modifier (optional) The accessibility of the resource: public or private.

The default is public.

Remarks
Use -linkresource to link a resource to an assembly and not add the resource file to the
output file.

By default, resources are public in the assembly when they are created by using the X#
compiler. To make the resources private, specify private as the accessibility modifier. No
other accessibility other than public or private is allowed.

If filename is a .NET Framework resource file created, for example, by Resgen.exe or in

the development environment, it can be accessed with members in the
System.Resources namespace. For more information, see
System.Resources.ResourceManager. For all other resources, use the
GetManifestResource* methods in the Assembly class to access the resource at run time.

-res is the short form of -resource.

The order of the resources in the output file is determined from the order specified on the
command line.

To set this compiler option in the Visual Studio development environment

1. Add a resource file to your project.

2. Select the file that you want to embed in Solution Explorer.
3. Select Build Action for the file in the Properties window.
4. Set Build Action to Embedded Resource.

© 2015- 2019 XSharp BV

 347 XSharp Bandol

For information about how to set this compiler option programmatically, see BuildAction.

Example
Compile in.prg and attach resource file rf.resource:

xsc -resource:rf.resource in.prg

1.7.2.3.59 -ruleset

Specify a ruleset file that disables specific diagnostics.

Syntax

-ruleset:filename

1.7.2.3.60 -s

Performs a syntax check on the input files only. Does not produce the output exe, dll or
pdb

Syntax

-s[+|-]

Arguments
+ | - Specifying +, or just -s, tells the compiler to only parse the source
code and not to generate an output file. When combined with The -ppo
option then there will be .ppo files written.

Remarks
This command line option allows you to check the code without generating a binary.

© 2015- 2019 XSharp BV

 X# Documentation 348

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Build tab.
3. Add the option in the "Extra Command Line options" property

1.7.2.3.61 -show defs

Shows the #define tokens that the preprocessor sees

Syntax

/showdefs[+|-]

Arguments
+ | - Specifying +, or just /showdefs, causes the compiler to output the
names of #defines as they are processed.

Remarks
This commandline option is useful to debug the defines that are included in the
compilation

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Build tab.
3. Add the option in the "Extra Command Line options" property

1.7.2.3.62 -show includes

The -showincludes option causes the compiler to output the names of #include files as
they are processed.

Syntax

© 2015- 2019 XSharp BV

 349 XSharp Bandol

-showincludes[+|-]

Arguments
+ | - Specifying +, or just -showincludes, causes the compiler to output the
names of #include files as they are processed.

Remarks
This option is useful in order to determine the files the compiler is processing as a result
of an #include directive. Nested include files are also displayed.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page.

2. Click the Build tab.
3. Add the option in the "Extra Command Line options" property

1.7.2.3.63 -snk

The -snk compiler option is an alias for the -keyfile option, for compatibility with Vulcan

1.7.2.3.64 -stddefs

Override the name of the standard defines file (default = XSharpDefs.xh)

Syntax

-stddefs:filepath

Arguments
filepath The name and path of the header file to use in stead of XSharpDefs.Xh.
When no path is included then the compiler will use the Includepath
specified from the commandline (-i)

1.7.2.3.65 -subsystemversion

Specifies the minimum version of the subsystem on which the generated executable file
can run, thereby determining the versions of Windows on which the executable file can
run. Most commonly, this option ensures that the executable file can leverage particular
security features that aren’t available with older versions of Windows.

© 2015- 2019 XSharp BV

 X# Documentation 350

Note
To specify the subsystem itself, use The -target compiler option.

Syntax

-subsystemversion:major.minor

Parameters
major.minor The minimum required version of the subsystem, as expressed in a
dot notation for major and minor versions. For example, you can
specify that an application can't run on an operating system that's
older than Windows 7 if you set the value of this option to 6.01, as the
table later in this topic describes. You must specify the values for
major and minor as integers.

Leading zeroes in the minor version don't change the version, but trailing zeroes do. For
example, 6.1 and 6.01 refer to the same version, but 6.10 refers to a different version. We
recommend expressing the minor version as two digits to avoid confusion.

Remarks
The following table lists common subsystem versions of Windows.
Windows version Subsystem version
Windows 2000 5.00
Windows XP 5.01
Windows Server 2003 5.02
Windows Vista 6.00
Windows 7 6.01
Windows Server 2008 6.01
Windows 8 6.02

Default values
The default value of The -subsystemversion compiler option depends on the conditions in
the following list:

· The default value is 6.02 if any compiler option in the following list is set:
o -target:appcontainerexe
o -target:winmdobj
o -platform:arm

© 2015- 2019 XSharp BV

 351 XSharp Bandol

· The default value is 6.00 if you're using MSBuild, you're targeting .NET Framework
4.5, and you haven't set any of the compiler options that were specified earlier in this
list.
· The default value is 4.00 if none of the previous conditions is true.

Setting this option

To set The -subsystemversion compiler option in Visual Studio, you must open the .xsproj
file and specify a value for the SubsystemVersion property in the MSBuild XML. You can't
set this option in the Visual Studio IDE.

1.7.2.3.66 -target

The -target compiler option can be specified in one of four forms:

-target:appcontainerexe To create an .exe file for Windows 8.x Store apps.

-target:exe To create an .exe file.
-target:library To create a code library.
-target:module To create a module.
-target:winexe To create a Windows program.
-target:winmdobj To create an intermediate .winmdobj file.

Unless you specify -target:module, -target causes a .NET Framework assembly manifest
to be placed in an output file. For more information, see Assemblies in the Common
Language Runtime and Common Attributes.
The assembly manifest is placed in the first .exe output file in the compilation or in the first
DLL, if there is no .exe output file. For example, in the following command line, the
manifest will be placed in 1.exe:

xsc -out:1.exe t1.prg -out:2.netmodule t2.prg

The compiler creates only one assembly manifest per compilation. Information about all
files in a compilation is placed in the assembly manifest. All output files except those
created with -target:module can contain an assembly manifest. When producing multiple
output files at the command line, only one assembly manifest can be created and it must
go into the first output file specified on the command line. No matter what the first output
file is (/target:exe, -target:winexe, -target:library or -target:module), any other output files
produced in the same compilation must be modules (/target:module).

If you create an assembly, you can indicate that all or part of your code is CLS compliant
with the CLSCompliantAttribute attribute.

© 2015- 2019 XSharp BV

 X# Documentation 352

-/ target_clscompliant.prg
[assembly:System.CLSCompliant(true)] -/ specify assembly compliance

[System.CLSCompliant(false)]; -/ specify compliance for an element

CLASS TestClass

PUBLIC STATIC METHOD Start AS VOID

RETURN
END CLASS

For more information about setting this compiler option programmatically, see
OutputType.Enter topic text here.

1.7.2.3.67 -touchedfiles

The -touchedfiles compiler option allows you to declare a file in which the compiler will list
which files have been touched during the compilation process.

Syntax

-touchedfiles:filename

Remarks
The compiler will produce 2 output files:

filename.read This lists all the files that were read by the compiler
filename.write This lists all the files that were written by the compiler. That
includes the exe, pdb, ppo etc.

The file names in both files are all capitalized and in alphabetical order

1.7.2.3.68 -undeclared

The -undeclared option tells the compiler to enable the support for 'undeclared variables'

Syntax

-undeclared [+ | -]

© 2015- 2019 XSharp BV

 353 XSharp Bandol

Arguments
+ |- Specifying +, or just -undeclared, directs the compiler to enable the
support for 'undeclared variables'

Remarks
When the compiler detects an 'unknown identifier' it will assume that this is either a field in
the current workarea or a memory variable.
The compiler option will only have effect when you also enabled -memvar

1.7.2.3.69 -unsafe

The -unsafe compiler option allows code that uses the unsafe keyword to compile.

Syntax

-unsafe

Remarks

For more information about unsafe code, see Unsafe Code and Pointers.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Language property page.
3. Set the Allow Unsafe Code property in the General Section

Example
Compile in.prg for unsafe mode:

xsc -unsafe in.prg

© 2015- 2019 XSharp BV

 X# Documentation 354

1.7.2.3.70 -utf8output

The -utf8output option displays compiler output using UTF-8 encoding.

Syntax

-utf8output

Remarks
In some international configurations, compiler output cannot correctly be displayed in the
console. In these configurations, use -utf8output and redirect compiler output to a file.

This compiler option is unavailable in Visual Studio and cannot be changed

programmatically.

1.7.2.3.71 -vo1

The -vo1 compiler option directs the compiler to treat Init() methods as constructors and
Axit methods as Destructor.

Syntax

-vo1[+ | -]

Arguments
+ |- Specifying +, or just -vo2, directs the compiler to initialize all variables
and fields of type STRING and all elements of DIM ... AS STRING
arrays to an empty string (String.Empty).

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Allow Init() and Axit() for
Constructor/Destructor" property.

© 2015- 2019 XSharp BV

 355 XSharp Bandol

1.7.2.3.72 -vo10

The -vo10 option enables the IIF operator to behave in a manner compatible with Visual
Objects

Syntax

-vo10[+|-]

Arguments
+ | - Specifying +, or just -vo10, causes the IIF operator to behave as it
does in Visual Objects.

Remarks
If the true and false expressions in an IIF operator are not the same, or one cannot be
implicitly converted to the type of the other, the compiler will raise an error.

Visual Objects allows this, and implicitly converts both expressions to USUAL, causing the
IIF expression to also return USUAL. This is neither safe or efficient, but code originally
written in Visual Objects may depend on this behavior, and if -vo10 is not used, errors
may occur at runtime.

LOCAL x as LOGIC
x := TRUE
? IIF( x, 1, "Sunday")

When you use The -vo10 compiler option then the compiler will convert this to:

? IIF( x, (USUAL)1, (USUAL) "Sunday") -/ for the VO and Vulcan

dialect

or

? IIF( x, (OBJECT)1, (OBJECT) "Sunday") -/ for the Core dialect

To set this compiler option in the Visual Studio development environment:

© 2015- 2019 XSharp BV

 X# Documentation 356

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Compatible IIF Behavior"
property.

1.7.2.3.73 -vo11

The -vo11 option enables Visual Objects compatible arithmetic conversions.

This option is not supported yet in the current version of the compiler

Syntax

-vo11[+|-]

Arguments
+ | - Specifying +, or just -vo11, directs the compiler to emit code that
performs arithmetic conversions that are compatible with Visual
Objects.

Remarks

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Compatible numeric
conversions" property.

1.7.2.3.74 -vo12

The -vo12 option enables Clipper compatible integer divisions.

Syntax

-vo12[+|-]

© 2015- 2019 XSharp BV

 357 XSharp Bandol

Arguments
+ |- Specifying +, or just -vo12, directs the compiler to emit code that
performs Clipper-compatible integer divisions.
Remarks
When The -vo12 option is enabled and both operands of The - (division) operator are
integral values, both operands are converted to USUAL, and the return type is USUAL. The
return value contained in the USUAL is:

INT64 (UsualType() == 22), if one or both operands are greater than

Int32.MaxValue and the remainder of the division is zero
INT (UsualType() == 1), if one or both operands are INT or a smaller
integral type and the remainder of the division is zero
FLOAT (UsualType() == 3), if one or both operands are INT or a smaller
integral type and the remainder of the division is not zero

The -vo12 option is enabled in projects created by the Transporter if the Compiler-
>Clipper Compatiblity->Integer Divisions option was enabled for the project in Visual
Objects.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Clipper Compatible integer
divisions" property.

1.7.2.3.75 -vo13

The -vo13 option enables VO compatible string comparisons

Syntax

-vo13[+|-]

Arguments
+ |- Specifying +, or just -vo13, tells the compiler that string comparisons
are to be performed the same way as they are in VO, and in the
RDDs, where the comparison depends on the SetCollation() setting.
When - is specified, or -vo13 is not specified, string comparisons in
code use String.Compare()

© 2015- 2019 XSharp BV

 X# Documentation 358

Remarks
When this option is enabled string comparisions are compatible with VO and the RDDs,
and depend on SetCollation() as follows:

When collation=#WINDOWS, string comparisons make use of services provided by

Windows that automatically handle foreign character sets. These string comparisons are
implemented with a call to CompareStringA() function in kernel32.dll.

When collation = #CLIPPER, comparisons are performed byte by byte, using a weight
table for each char. As in VO, a different table can be selected with the SetNatDll()
function.
In .Net we are using the runtime DLL for the weight tables. In the runtime the nation DLLs
are not physically implemented as separate files; the weighting tables are embedded as
resources inside XSharp.Core.dll.

When collation = #Unicode then the comparisons will be done with the normal
String.Compare() routine that uses the current culture.

When collation = #Ordinal then the comparisons will be done with the normal
String.Compare() routine using an ordinal comparison (this is the fastest)

When -v013 is not enabled string comparisons are performed using String.Compare(),
where the comparison makes use of culture-sensitive sort rules according to the current
culture selected.

The setting for -vo13 is registered with the runtime by the main application at startup. If
you library is compiled with -vo13+ but the main app isn't, then the string comparisons
called from the library will follow the same rules as the main app because the main app
registers -vo13 setting with the runtime and the stringcomparison routines in the runtime
now detect that the main app does not want to do VO compatible string comparisons.
We therefore recommend that 3rd party products always enable -vo13.

Compatibility Note:
When using -vo13 string comparisons involve converting unicode strings to ansi for
compatibility and consequently are slower than with String.Compare().

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Compatible string
comparisons" property.

© 2015- 2019 XSharp BV

 359 XSharp Bandol

1.7.2.3.76 -vo14

The -vo14 option enables VO compatible handling of floating point literal numbers

Syntax

-vo14[+|-]

Arguments
+ |- Specifying +, or just -vo14, tells the compiler treat floating point literal
numbers (for example: 123.456) as FLOAT data type, instead of as
REAL8 (System.Double), which is the default.

Remarks
When this option is enabled, floating point literal numbers are treated by the compiler as
FLOAT values, for compatibility with existing Visual Objects code. This option is enabled
by default in transported projects.

For new code, it is strongly recommended not to enable this compiler option, as it
generates less efficient code. For example, for the following code:

if -vo14 is enabled, the compiler treats the "1.0", "1.5" and "2.5" values as numbers of type
FLOAT, causing the whole calculation to be made on FLOAT values and the result is at
the end converted to REAL8, before it is finally stored to the local variable. FLOAT is a
special data type defined in the Vulcan.NET runtime and is significantly slower than the
REAL8 (System.Decimal) data type, which maps directly to a (mathematic) processor
registry. Disabling -vo14 option, would cause the above code to execute faster by a large
factor.

Note that by using the "d" or "s" suffix, as in 123.456d and 123.456s, the REAL8 or REAL4
data type is being enforced on a literal number, no matter if -vo14 is enabled or disabled.
See Literals for more information.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Use FLOAT literals" property.

© 2015- 2019 XSharp BV

 X# Documentation 360

1.7.2.3.77 -vo15

This compiler option will allow you to control what the compiler will do with local variables,
parameters and return types without type specification.
The default is -vo15+ for the VO and Vulcan dialects. For the Core dialect the default is -
vo15-

Syntax

-vo15[+|-]

Arguments
+ |- Specifying +, or just -vo14, tells the compiler treat floating point literal
numbers (for example: 123.456) as FLOAT data type, instead of as
REAL8 (System.Double), which is the default.

For example

FUNCTION LongSquare(nLong as LONG) -/ Note that the return type is

missing

RETURN nLong * nLong

In VO/Vulcan mode this will (by default) generate a method with a USUAL return type. In
Core mode this will not compile but produce a "Missing Type" error (XS1031)

When you compile with -vo15- this will also produce an error.

Similar code that will be influenced by this compiler option

FUNCTION MultiplyLong(nParam1 as LONG, nParam2) AS LONG -/ Note that the

type for nParam2 is missing
RETURN nParam1 * nParam2

And

© 2015- 2019 XSharp BV

 361 XSharp Bandol

FUNCTION Tomorrow() AS Date

LOCAL dToday := Today() -/ Note that the AS DATE is
missing
RETURN dToday + 1

1.7.2.3.78 -vo16

Automatically generate Clipper calling convention constructors for classes without

constructor

Example:

CLASS Event
EXPORT hWnd AS PTR
EXPORT uMsg AS DWORD
EXPORT wParam AS DWORD
EXPORT lParam AS LONG
EXPORT oWindow AS OBJECT

CONSTRUCTOR(_hWnd, _uMsg, _wParam, _lParam, _oWindow)

SELF:hWnd := _hWnd
SELF:uMsg := _uMsg
SELF:wParam := _wParam
SELF:lParam := _lParam
SELF:oWindow := _oWindow
END CLASS

CLASS ControlEvent INHERIT Event

END CLASS

In the code above the compiler would generate a constructor for the ControlEvent class.
This constructor will pass all the parameters to the constructor of the Event class.

The generated constructor would look like:

CONSTRUCTOR(_hWnd, _uMsg, _wParam, _lParam, _oWindow)

SUPER(_hWnd, _uMsg, _wParam, _lParam, _oWindow)

© 2015- 2019 XSharp BV

 X# Documentation 362

1.7.2.3.79 -vo2

The -vo2 option directs the compiler to initialize all variables and fields of type STRING
(System.String) and all elements of DIM ... AS STRING arrays to an empty string (/vo2[+|-]

Syntax

-vo2[+ | -]

Arguments
+ |- Specifying +, or just -vo2, directs the compiler to initialize all variables
and fields of type STRING and all elements of DIM ... AS STRING
arrays to an empty string (String.Empty).

Remarks
This option is off by default, and all locals, globals, fields and array elements of type
STRING have an initial value of NULL, which is the default initial value for any local, global,
field or array element that contains a reference type.

Generally you will initialize a string variable to a specific value before it is used, and
initializing it to an empty string would incur unnecessary overhead. In addition, it is
inconsistent with the behavior of all other reference types, which have an initial value of
NULL. However, this may break existing Visual Objects code that relies on Visual Object's
behavior of initializing string variables to a string with zero characters.

When this option is not used, you may test for an empty string variable, field or array
element by comparing it against NULL. When this option is enabled, you may test for an
empty string variable, field or array element by comparing it against "" or String.Empty, or
testing that its length equals zero. System.String.IsNullOrEmpty() may also be used to
test whether a string variable contains NULL or a valid string with zero characters.

Also note that the predefined constant NULL_STRING is normally equivalent to NULL, but
when -vo2 is used, NULL_STRING is equivalent to "" (a zero-length string).

Compatibility Note:
-vo2 does not initialize STRING fields in structures. Since structures do not have default
constructors, structure fields cannot have initializer expressions. Although this is not a
compatiblity issue since you cannot create structures (value types) in Visual Objects, it is
something to keep in mind if you use structures in an application that uses -vo2.

Note that the use of the term "structure" here refers to STRUCTURE in X#, not
STRUCTURE in Visual Objects, which has been renamed VOSTRUCT in X#. -vo2 has no
effect on VOSTRUCT since you cannot declare fields that are reference types in a
VOSTRUCT.

© 2015- 2019 XSharp BV

 363 XSharp Bandol

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Initialize strings" property.

Example

1.7.2.3.80 -vo3

The -vo3 option directs the compiler to treat all methods (including ACCESS and ASSIGN
methods) as virtual.

Syntax

-vo3[+|-]

Arguments
+ |- Specifying +, or just -vo3, directs the compiler to treat all methods
(including ACCESS and ASSIGN methods) as virtual, regardless of
whether the VIRTUAL modifier is used or not. This provides
compatibility with the Visual Objects inheritance model.
Remarks
A class method may always be explicitly declared as a virtual method by using the
VIRTUAL keyword, regardless of whether -vo3 is used or not.

For performance reasons, this option is off by default. Virtual methods incur a slight
performance penalty since the actual method implementation that is called cannot be
determined until run-time, and depends on the run-time type of the instance on which the
invocation takes place. In contrast, calls to non-virtual members can be fully resolved at
compile time, and the call is always made to the compile-time type of the instance.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.

© 2015- 2019 XSharp BV

 X# Documentation 364

3. In the Visual Objects Compatibility section, modify the "All instance methods virtual"
property.

Example

When The -vo3 switch is not used, the call to 'c:WhoAmI()' always resolves to the
implementation in BaseClass, since the variable 'c' is typed as 'BaseClass' and
'BaseClass.WhoAmI' is a non-virtual method.

When The -vo3 switch is used, the call to 'c:WhoAmI()' resolves to the implementation in
'DerivedClass'. Even though the variable 'c' is typed as 'BaseClass', the actual type of the
instance stored in 'c' at runtime determines what implementation of 'WhoAmI' to invoke
since 'BaseClass.WhoAmI' is a virtual method.

The same behavior without using -vo3 could be obtained by doing:

VIRTUAL METHOD WhoAmI() AS STRING CLASS BaseClass

...

This is preferable over using -vo3 since you have explicit control over which methods are
and are not virtual, and no unnecessary overhead is incurred where virtual inheritance is
not required. However, existing Visual Objects code may not work properly without -vo3,
and it may not be practical to modify existing code and add the VIRTUAL keyword to those
methods that really need it.

1.7.2.3.81 -vo4

The -vo4 option directs the compiler to implicitly convert signed integer types to/from
unsigned types, and larger integer types to smaller types.

Syntax

-vo4[+|-]

Arguments
+ |- Specifying +, or just -vo4, directs the compiler to implicitly convert
signed integer values to/from unsigned values, and larger integer types
to smaller integer types. This provides compatibility with Visual

© 2015- 2019 XSharp BV

365 XSharp Bandol

Objects, which permits such conversions without an explicit cast or

conversion operator.

Remarks
For safety reasons, this option is off by default. Implicitly converting between signed and
unsigned integer types or between larger to smaller integer types can cause numeric
overflow errors at runtime or unintended values to be passed depending upon whether
overflow checking is enabled or disabled. By default, you must explicitly cast a signed
integer to its unsigned counterpart and from larger integer types to smaller integer types
and by explicitly doing so, it is assumed that the conversion is known by the programmer
to be safe.

When this option is enabled, the compiler will implicitly convert the data types listed in the
table below:

From To
SByte BYTE, WORD, Char, DWORD
SHORT BYTE, SByte, WORD, Char, DWORD
INT BYTE, SByte, WORD, SHORT, Char,
DWORD
INT64 BYTE, SByte, WORD, SHORT, Char, INT,
DWORD, UINT64
BYTE SByte
WORD SByte, BYTE, SHORT, Char, INT
DWORD SByte, BYTE, WORD, SHORT, INT
UINT64 SByte, BYTE, WORD, SHORT, Char, INT,
DWORD, INT64

For each conversion, the compiler will raise an appropriate warning. You may disable the
warning with The -wx switch, or insert an explicit cast in the source code to eliminate the
warning.

It is strongly recommended that you do not use this compiler option in new code. All of the
conversions listed in the table above have the ability to lose data or return incorrect values,
since the range of values in the source data type cannot be represented in the target data
type.

For example, an INT containing a negative number cannot be represented in a DWORD.

Similarly, an INT greater than 65535 cannot be represeneted in a SHORT. If you must mix
signed and unsigned types or pass a larger type to a smaller type, you should always
supply an explicit cast rather than using -vo4. This will document the fact that the
conversion is known to be safe, and it will not suppress compile time errors if
incompatible integer types are unintentionally used.

© 2015- 2019 XSharp BV

 X# Documentation 366

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Implicit signed/unsigned
conversions" property.

Example

1.7.2.3.82 -vo5

The -vo5 option directs the compiler to implicitly use the CLIPPER calling convention for
functions declared with zero-arguments and no explicit calling convention.

Syntax

-vo5[+|-]

Arguments
+ |- Specifying +, or just -vo5, directs the compiler to implicitly use the
CLIPPER calling convention for functions, methods and constructors
that are declared with zero arguments and no explicit calling
convention.

Remarks
For compatibility with Clipper, Visual Objects uses the CLIPPER calling convention for all
functions and methods that are declared with zero arguments and no explicit calling
convention. The STRICT keyword may be used to override the default, and cause the
function to use the STRICT calling convention.

However, in the vast majority of cases, parameters are never passed to functions and
methods declared with zero arguments, and using the CLIPPER calling convention by
default incurs unnecessary overhead not only in the function itself, but at every call site. In
addition, the CLIPPER calling convention allows any number and type of arguments to be
passed, preventing compile time error checking.

In X#, functions and methods declared with zero arguments are compiled with the
STRICT calling convention by default, unless the CLIPPER keyword is explicitly specified.
This behavior is the exact opposite of Visual Objects, but results in more efficient code as

© 2015- 2019 XSharp BV

 367 XSharp Bandol

well as compile time error checking. Passing any arguments to a function declared to
accept zero arguments will raise a compile-time error.

However, this can cause compatibility issues in code originally written in Visual Objects.
The -vo5 compiler option reverses the default behavior of X# with regard to zero argument
functions, so that the behavior is identical to Visual Objects.

Regardless of whether this option is enabled or not, the CLIPPER and STRICT keywords
can always be used to explicitly specify the desired calling convention.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Implicit CLIPPER calling
convention" property.

Example

The above example will compile and run correctly if -vo5 is used, or if the CLIPPER
keyword is added at the end of the FUNCTION foo() declaration. Otherwise, a compiler
error will be generated on the call to foo(), as well as on the calls to pcount() and
_getFParam() (which are illegal in a STRICT calling convention function).

1.7.2.3.83 -vo6

The -vo6 option directs the compiler to resolve typed function pointers to PTR.

Syntax

-vo6[+|-]

Arguments
+ |- Specifying +, or just -vo6, directs the compiler to resolve pointers that
would resolve to typed function pointers in Visual Objects to PTR.

© 2015- 2019 XSharp BV

 X# Documentation 368

Remarks
X# does not supported typed function pointers. Existing Visual Objects code that declares
typed function pointers will not compile in X#, unless the type is changed to PTR or IntPtr.

If this option is enabled and a pointer type cannot be resolved, the compiler will attempt to
locate a function with the same name as the pointer type (without "PTR"). If found, the
compiler will resolve the type to PTR. This allows existing Visual Objects code to be
compiled without modification, at least as far as the variable declaration is concerned.

The pointer type may be used as an argument to CCallNative(), PCallNative() or

CallManaged(), depending on the type of function the pointer points to.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Implicit pointer conversions"
property.

Example
The following code is valid in Visual Objects, but will not compile in X# unless -vo6 is
used.

Using -vo6 has the same effect as if the GLOBAL declaration were rewritten as:

GLOBAL pFoo AS PTR

Note that PTR does not have the same semantics as typed function pointers in Visual
Objects. However, typed function pointers are primarily used as arguments to CALL(),
CCALL() and PCALL() in Visual Objects, which are not supported in X#. They have been
replaced with CCallNative(), PCallNative() and CallManaged(), which accept IntPtr
arguments. The same end result (invoking a function indirectly through a pointer) is
therefore possible in X# without typed function pointers.

© 2015- 2019 XSharp BV

 369 XSharp Bandol

1.7.2.3.84 -vo7

The -vo7 option directs the compiler to allow implicit casts and conversions that are
allowed in Visual Objects but which would normally be illegal or require an explicit cast in
X#.

Syntax

-vo7[+|-]

Arguments
+ |- Specifying +, or just -vo7, directs the compiler to allow certain implicit
casts and conversions that are allowed in Visual Objects.

Remarks
Visual Objects allows implicit casts between types with different semantics, whereas X#
normally requires explicit casts in such cases.

For example, Visual Objects allows implicit conversions between integer types and pointer
types. While pointers are integers, they have different semantics. Integers are numerical
values and pointers are addresses representing memory locations. In addition to the
difference in semantics, the size of a pointer is dependent upon the underlying platform
whereas the size of an integer does not change from platform to platform (with the
exception of System.IntPtr).

While is it possible (and often necessary) to cast between types with different semantics,
it should always be done via an explicit cast. This not only insures that the correct
conversion code is generated (if necessary), it also self-documents the fact that you are
casting one type to another type that has a different meaning.

X# supports most of the casts that Visual Objects supports, but in cases where the types
have different semantics, an explicit cast is usually required. However, this can cause a
large number of compiler errors in existing Visual Objects code.

Using -vo7 allows the following conversions to be performed implicitly, allowing existing
Visual Objects code to compile:
From To Operation Performed
PTR strongly typed None, the types are binary compatible. However, the
PTR (e.g. INT code may fail at runtime if the data the pointer points
PTR) to is not the correct type.
INT or strongly typed None, the types are binary compatible. However, the
DWORD PTR (e.g. INT code may fail at runtime if the data the pointer points
PTR) to is not the correct type. Note that this conversion is
only allowed when the target platform is set to x86.

© 2015- 2019 XSharp BV

 X# Documentation 370

INT64 or strongly typed None, the types are binary compatible. However, the
UINT64 PTR (e.g. INT code may fail at runtime if the data the pointer points
PTR) to is not the correct type. Note that this conversion is
only allowed when the target platform is set to x64 or
Itanium.
OBJECT any other Compiler inserts an explicit cast to the target type,
reference type which may fail at runtime.
type PTR REF type The compiler converts the pointer into a reference.
Note that even with -vo7, not all pointers can be
converted to references or else it would compromise
the integrity of the garbage collector.

Example
The following code is valid in Visual Objects, but will not compile in X# unless -vo7 is
used, because CreateObject() returns OBJECT and there is no implicit conversion from
OBJECT to a more derived type (such a conversion cannot be guaranteed to be safe, and
implicit conversions are always safe).

Using -vo7 has the same effect as if the assignment into f were rewritten as:

In either case, the resulting code is exactly the same, and the cast to foo may fail at
runtime. However, the explicit cast self-documents that you expect the return from
CreateObject() to contain an instance of foo.

The following example is also valid in Visual Objects, but will not compile in X# unless -vo7
is used, because the @ operator returns the address of its operand (a typed pointer) and
pointers are not the same as references in X#:

The -vo7 option will automatically convert @x, which resolves to type INT PTR, into REF
INT which is compatible with the function parameter. However, it is recommended that
you remove the @ operator rather than use -vo7 for this purpose.

© 2015- 2019 XSharp BV

 371 XSharp Bandol

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the Compatible "Implicit casts and
conversions" property.

1.7.2.3.85 -vo8

The -vo8 option enables Visual-Objects compatible preprocessor behavior.

Syntax

-vo8[+|-]

Arguments
+ | - Specifying +, or just -vo8, changes certain aspects of the
preprocessor to behave like Visual Objects.

Remarks
Unlike Visual Objects, X# uses a file-based preprocessor which has characteristics of
traditional preprocessors in languages such as C, C++ and Clipper. The -vo8 option
controls the following behaviors:

· Case Sensitivity

In a traditional preprocessor, #define foo 1 and #define FOO 2 declare two separate
preprocessor symbols, because preprocessor symbols are case-sensitive.

However, in Visual Objects, DEFINE foo := 1 and DEFINE FOO := 2 declare the same
entity (and would cause a compiler error because of the duplicate entity declaration).

When -vo8 is used, #define foo 1 and #define FOO 2 declare the same preprocessor
symbol (and would cause a compiler warning because of the redefinition).

The following code is valid in Visual Objects:

© 2015- 2019 XSharp BV

 X# Documentation 372

but the following code will raise an unknown variable error on ? Foo because the X#
preprocessor is case-sensitive by default:

Using The -vo8 option will allow the above example to compile. An alternative to using -vo8
is to modify the code so that the case of the text you want to replace matches the case
used in #define.

· #ifdef

In a traditional preprocessor, code within a #ifdef ... #endif (or #else) block is compiled if
the symbol after #ifdef is defined. It does not matter what the symbol resolves to, if it
resolves to anything at all.

In Visual Objects, code within a #ifdef ... #endif (or #else) block is compiled only if the
symbol after #ifdef is defined, and it resolves to an expression which resolves to a logical
TRUE value. In the example below, The code will print "in #else":

whereas the equivalent code in X# would print "in #ifdef":

When -vo8 is used, the X# preprocessor examines the value of the preprocessor symbol
to determine if the symbol resolves to a logical TRUE or FALSE value. However, the X#
preprocessor does not evaluate preprocessor expressions, whereas Visual Objects does.
Even with -vo8 enabled, the preprocessor symbol must resolve to a single expression
containing TRUE or FALSE (case-insensitive) or a numerical value. Numerical values of 0
resolve to FALSE and all non-zero numbers resolve to TRUE. Preprocessor symbols that
resolve to expressions are not evaluated and effectively resolve to FALSE.

For example:

Tip:
The -ppo option is useful for debugging the output generated by the preprocessor.

© 2015- 2019 XSharp BV

 373 XSharp Bandol

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.
3. In the Visual Objects Compatibility section, modify the "Compatible preprocessor"
property.

1.7.2.3.86 -vo9

The -vo9 option prevents the compiler from raising error XS0161 when a function or
method does not have any RETURN statements

Syntax

-vo9[+|-]

Arguments
+ |- Specifying +, or just -vo9, allows functions and methods that do not
have any RETURN statement to compile without raising an error.

Remarks
Visual Objects allows functions and methods whose return type is not VOID to omit
RETURN statements. The return value from any such functions or methods will always be
the default value for the return type.

This is illegal in X#: all functions and methods must explicitly return a value unless the
return type is VOID. However, this may prevent code that was originally written in Visual
Objects from compiling in X#.

If -vo9 is enabled, any non-void functions or methods that do not have any RETURN
statements will raise warning XS9025 instead of error XS0106. The warning may be
disabled if desired, but it is strongly recommended that you fix the code in question. If the
return value is never used, then type the function or method AS VOID. Otherwise, add a
RETURN statement with an appropriate return value.
This compiler option also checks for methods/functions that have a return statement
without value. In that case a warning XS9026 is shown.
The final check this compiler option does it for methods that have a return value but are
not expected to return anything. If that is found then a warning XS9032 is shown.

To set this compiler option in the Visual Studio development environment:

1. Open the project's Properties page

2. Click the Language tab.

© 2015- 2019 XSharp BV

 X# Documentation 374

3. In the Visual Objects Compatibility section, modify the "Allow missing return
statements" property.

Example

In the first example, the return type is not specified so it defaults to USUAL, and since
there is no RETURN statement the function will always returns NIL (the default value for
USUAL) in Visual Objects. In the second example, since there is no RETURN statement
the method will always return zero (the default value for INT) in Visual Objects.

1.7.2.3.87 -w

The -w compiler option is an alias for the -nowarn command line option for compatibility
with Vulcan.

1.7.2.3.88 -w arn

The -warn option specifies the warning level for the compiler to display.

Syntax

-warn:option

Arguments
option The warning level you want displayed for the compilation: Lower
numbers show only high severity warnings; higher numbers show
more warnings. Valid values are 0-4:
Warning level Meaning
0 Turns off emission of all warning messages.
1 Displays severe warning messages
2 Displays level 1 warnings plus certain, less-severe warnings,
such as warnings about hiding class members.
3 Displays level 2 warnings plus certain, less-severe warnings,
such as warnings about expressions that always evaluate to true
or false.
4 (the default) Displays all level 3 warnings plus informational warnings.

© 2015- 2019 XSharp BV

 375 XSharp Bandol

Remarks
To get information about an error or warning, you can look up the error code in the Help
Index. For other ways to get information about an error or warning, see X# Compiler
Errors.

Use -warnaserror to treat all warnings as errors. Use -nowarn to disable certain warnings.

-w is the short form of -warn.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Modify the Warning Level property.

For information on how to set this compiler option programmatically, see WarningLevel.

Example
Compile in.prg and have the compiler only display level 1 warnings:

xsc -warn:1 in.prg

1.7.2.3.89 -w arnaserror

The -warnaserror+ option treats all warnings as errors

Syntax

-warnaserror[+|-][:warning-list]

Remarks
Any messages that would ordinarily be reported as warnings are instead reported as
errors, and the build process is halted (no output files are built).

By default, -warnaserror- is in effect, which causes warnings to not prevent the generation
of an output file. -warnaserror, which is the same as -warnaserror+, causes warnings to
be treated as errors.

© 2015- 2019 XSharp BV

 X# Documentation 376

Optionally, if you want only a few specific warnings to be treated as errors, you may
specify a comma-separated list of warning numbers to treat as errors.

Use -warn to specify the level of warnings that you want the compiler to display. Use -
nowarn to disable certain warnings.

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties page.

2. Click the Build property page.
3. Modify the "Warnings As Errors" property.

Example
Compile in.prg and have the compiler display no warnings:

xsc -warnaserror in.prg

xsc -warnaserror:642,649,652 in.prg

1.7.2.3.90 -w in32icon

The -win32icon option inserts an .ico file in the output file, which gives the output file the
desired appearance in the File Explorer.

Syntax

-win32icon:filename

Arguments
filename The .ico file that you want to add to your output file.

Remarks
An .ico file can be created with the Resource Compiler. The Resource Compiler is
invoked when you compile a Visual C++ program; an .ico file is created from the .rc file.

See -linkresource (to reference) or -resource (to attach) a .NET Framework resource file.
See -win32res to import a .res file.

© 2015- 2019 XSharp BV

 377 XSharp Bandol

To set this compiler option in the Visual Studio development environment

1. Open the project's Properties pages.

2. Click the Application property page.
3. Modify the Application icon property.

Example
Compile in.prg and attach an .ico file rf.ico to produce in.exe:

xsc -win32icon:rf.ico in.prg

1.7.2.3.91 -w in32manifest

Use The -win32manifest option to specify a user-defined Win32 application manifest file to
be embedded into a project's portable executable (PE) file.

Syntax

-win32manifest: filename

Arguments
filename The name and location of the custom manifest file.

Remarks
By default, the X# compiler embeds an application manifest that specifies a requested
execution level of "asInvoker." It creates the manifest in the same folder in which the
executable is built, typically the bin\Debug or bin\Release folder when you use Visual
Studio. If you want to supply a custom manifest, for example to specify a requested
execution level of "highestAvailable" or "requireAdministrator," use this option to specify
the name of the file.

Note
This option and the -win32res option are mutually exclusive. If you try to use both options
in the same command line you will get a build error.

© 2015- 2019 XSharp BV

 X# Documentation 378

An application that has no application manifest that specifies a requested execution level
will be subject to file/registry virtualization under the User Account Control feature in
Windows Vista.
Your application will be subject to virtualization if either of these conditions is true:

· You use the -nowin32manifest option and you do not provide a manifest in a later build
step or as part of a Windows Resource (.res) file by using The -win32res option.
· You provide a custom manifest that does not specify a requested execution level.

Visual Studio creates a default .manifest file and stores it in the debug and release
directories alongside the executable file. You can add a custom manifest by creating one
in any text editor and then adding the file to the project. Alternatively, you can right-click the
Project icon in Solution Explorer, click Add New Item, and then click Application Manifest
File. After you have added your new or existing manifest file, it will appear in the Manifest
drop down list.

You can provide the application manifest as a custom post-build step or as part of a
Win32 resource file by using the -nowin32manifest option. Use that same option if you
want your application to be subject to file or registry virtualization on Windows Vista. This
will prevent the compiler from creating and embedding a default manifest in the portable
executable (PE) file.

Example
The following example shows the default manifest that the X# compiler inserts into a PE.

Note
The compiler inserts a standard application name " MyApplication.app " into the xml. This
is a workaround to enable applications to run on Windows Server 2003 Service Pack 3.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
<assemblyIdentity version="1.0.0.0" name="MyApplication.app"/>
<trustInfo xmlns="urn:schemas-microsoft-com:asm.v2">
<security>
<requestedPrivileges xmlns="urn:schemas-microsoft-com:asm.v3">
<requestedExecutionLevel level="asInvoker"/>
</requestedPrivileges>
</security>
</trustInfo>
</assembly>

1.7.2.3.92 -w in32res

The -win32res option inserts a Win32 resource in the output file.

Syntax

© 2015- 2019 XSharp BV

 379 XSharp Bandol

-win32res:filename

Arguments
filename The resource file that you want to add to your output file.

Remarks
A Win32 resource file can be created with the Resource Compiler. The Resource
Compiler is invoked when include native resources (.RC files) in your X# Visual studio
solution

A Win32 resource can contain version or bitmap (icon) information that would help identify
your application in the File Explorer. If you do not specify -win32res, the compiler will
generate version information based on the assembly version. You can also include Menu
and Dialog definitions in a RC file.

See -linkresource (to reference) or -resource (to attach) a .NET Framework resource file.

To set this compiler option in the Visual Studio development environment

You cannot set this compiler option inside Visual Studio. If your application has native
resource files, then the build system will automatically convert this to a
nativeresources.res file and include this file with The -win32res command line option in
your assembly.

Example
Compile in.prg and attach a Win32 resource file rf.res to produce in.exe:

xsc -win32res:rf.res in.prg

1.7.2.3.93 -w x

The -wx compiler option is an alias for the -warnaserror compiler option for Vulcan
compatibility

1.7.2.3.94 -xpp1

All XPP classes inherit from the Abstract class (default = OFF)

© 2015- 2019 XSharp BV

 X# Documentation 380

1.7.3 X# Compiler Errors and Warnings

The complete list of X# Compiler errors and warnings is not included in this "book like"
documentation but can be found in the CHM, Visual Studio Help and/or Webhelp

1.8 X# Examples
The following X# Examples will also be installed as an example solution on your machine
in the Users\Public\XSharp\Examples folder.

1.8.1 Anonymous Method Expressions

An example of an Anonymous Method Expression (AME) (note the DELEGATE keyword):
Note that the body of the that you can have :
1. A single Expression
2. An Expression List
3. A statement List
The first 2 require the expression(s) to be on the same line as the opening Curly { . Of
course you can use the statement continuation character ; to tell the compiler that you
have spread the statement over more than one line.
The last one requires the statements in the list to be on separate lines and the closing
Curly } must also be on a separate line. This is shown in the example below.

USING System.Windows.Forms
FUNCTION Start() AS VOID
TestAnonymous()
RETURN

FUNCTION TestAnonymous() AS VOID

LOCAL oForm AS Form
oForm := Form{}
oForm:Text := "Click me to activate the anonymous method"
oForm:Click += DELEGATE(o AS System.Object, e AS System.EventArgs ) {
System.Windows.Forms.MessageBox.Show("Click 1!")
System.Windows.Forms.MessageBox.Show("Click 2!")
}
oForm:ShowDialog()
RETURN

1.8.2 Anonymous Types

Anonymous types are used a lot in relation to LINQ. See the LINQ example below. In the
first LINQ statement an anonymous class is created

The following example shows a couple of LINQ Queries in X#

USING System.Collections.Generic
USING System.Linq
USING STATIC System.Console

© 2015- 2019 XSharp BV

381 XSharp Bandol

FUNCTION Start AS VOID

VAR oDev := GetDevelopers()
VAR oC := GetCountries()
VAR oAll := FROM D IN oDev ;
JOIN C IN oC ON D:Country EQUALS C:Name ;
ORDERBY D:LastName ;
SELECT CLASS {D:Name, D:Country, C:Region} //
Anonymous class !
// The type of oAll is
IOrderedEnumerable<<>f__AnonymousType0<Developer,Country>> // We prefer
the VAR keyword!

VAR oGreek := FROM Developer IN oDev ;

WHERE Developer:Country == "Greece" ;
ORDERBY Developer:LastName DESCENDING ;
SELECT Developer
// The type of oGreek is IOrderedEnumerable<Developer>
// We prefer the VAR keyword!

VAR oCount := FROM Developer IN oDev ;

GROUP Developer BY Developer:Country INTO NewGroup ;
ORDERBY NewGroup:Key SELECT NewGroup
// The type of oCount is IOrderedEnumerable<<IGrouping<string,Developer>>
// We prefer the VAR keyword!

WriteLine(e"X# does LINQ!\n")

WriteLine(e"All X# developers (country+lastname order)\n")
FOREACH VAR oDeveloper IN oAll
WriteLine("{0} in {1}, {2}",oDeveloper:Name, oDeveloper:Country,
oDeveloper:Region)
NEXT

WriteLine(e"\nGreek X# Developers (descending lastname)\n")

FOREACH oDeveloper AS Developer IN oGreek
WriteLine(oDeveloper:Name)
NEXT

WriteLine(e"\nDevelopers grouped per country\n")

FOREACH VAR country IN oCount

WriteLine(i"{country.Key}, {country.Count()} developer(s)")
FOREACH VAR oDeveloper IN country
WriteLine(" " + oDeveloper:Name)
NEXT
NEXT
WriteLine("Enter to continue")
ReadLine()
RETURN

FUNCTION GetDevelopers AS IList<Developer>

// This function uses a collection initializer for the List of Developers
// and Object initializers for the Developer Objects
VAR oList := List<Developer>{} { ;
Developer{}{ FirstName := "Chris", LastName :=
"Pyrgas", Country := "Greece"},;

© 2015- 2019 XSharp BV

 X# Documentation 382

Developer{}{ FirstName := "Robert", LastName :=

"van der Hulst", Country := "The Netherlands"},;
Developer{}{ FirstName := "Fabrice", LastName :=
"Foray", Country := "France"},;
Developer{}{ FirstName := "Nikos", LastName :=
"Kokkalis", Country := "Greece"} ;
}
RETURN oList

FUNCTION GetCountries AS IList<Country>

// This function uses a collection initializer for the List of Counties
// and Object initializers for the Country Objects
VAR oList := List<Country>{}{ ;
Country{} {Name := "Greece", Region := "South
East Europe"},;
Country{} {Name := "France", Region := "West
Europe"},;
Country{} {Name := "The Netherlands", Region :=
"North West Europe"} ;
}
RETURN oList

CLASS Developer
PROPERTY Name AS STRING GET FirstName + " " + LastName
PROPERTY FirstName AS STRING AUTO
PROPERTY LastName AS STRING AUTO
PROPERTY Country AS STRING AUTO
END CLASS

CLASS Country
PROPERTY Name AS STRING AUTO
PROPERTY Region AS STRING AUTO
END CLASS

1.8.3 ASYNC Example

//
// This example shows that you can call an async task and wait for it to
finish
// The result of the async task (in this case the size of the file that has
been downloaded)
// will be come available when the task has finished
// The calling code (The Start()) function will not have to wait until the
async task has
// finished. That is why the line "2....." will be printed before the
results from TestClass.DoTest()
// The sample also shows an event and displays the thread id's. You can see
that the DownloadFileTaskAsync() method
// starts multiple threads to download the web document in multiple pieces.

USING System
USING System.Threading.Tasks

© 2015- 2019 XSharp BV

 383 XSharp Bandol

FUNCTION Start() AS VOID

? "1. calling long process"
TestClass.DoTest()
? "2. this should be printed while processing"
Console.ReadKey()

CLASS TestClass
STATIC PROTECT oLock AS OBJECT // To make sure we synchronize the
writing to the screen
STATIC CONSTRUCTOR
oLock := OBJECT{}

ASYNC STATIC METHOD DoTest() AS VOID

LOCAL Size AS INT64
Size := AWAIT LoooongProcess()
? "3. returned from long process"
? Size, " Bytes downloaded"

ASYNC STATIC METHOD LoooongProcess() AS Task<INT64>

VAR WebClient := System.Net.WebClient{}
VAR FileName := System.IO.Path.GetTempPath()+"temp.txt"
webClient:DownloadProgressChanged += OnDownloadProgress
webClient:Credentials :=
System.Net.CredentialCache.DefaultNetworkCredentials
AWAIT
webClient:DownloadFileTaskAsync("http://www.xsharp.info/index.php",
FileName)
VAR dirInfo :=
System.IO.DirectoryInfo{System.IO.Path.GetTempPath()}
VAR Files := dirInfo:GetFiles("temp.txt")
IF Files:Length > 0
System.IO.File.Delete(FileName)
RETURN Files[1]:Length
ENDIF
RETURN 0

STATIC METHOD OnDownloadProgress (sender AS OBJECT, e AS

System.Net.DownloadProgressChangedEventArgs) AS VOID
BEGIN LOCK oLock
? String.Format("{0,3} % Size: {1,8:N0} Thread {2}",
100*e:BytesReceived / e:TotalBytesToReceive , e:BytesReceived, ;
System.Threading.Thread.CurrentThread:ManagedThreadId)
END LOCK
RETURN

END CLASS

1.8.4 BEGIN UNSAFE Example

Enter topic text here.

© 2015- 2019 XSharp BV

 X# Documentation 384

1.8.5 BEGIN USING Example

//
// XSharp allows you to not only use the using statement to link to
namespaces
// You can also link to a static class and call the methods in this class as
if they are functions.
// The functions WriteLine and ReadKey() in the following code are actually
resolved as System.Console.WriteLine()
// and System.Console.ReadKey()
// Finally there is also the BEGIN USING .. END USING construct which
controls the lifetime of a variable
// At the end of the block the Variable will be automatically disposed.
USING System
USING STATIC System.Console

FUNCTION Start() AS VOID

WriteLine("Before Using Block")
WriteLine("------------------")
BEGIN USING VAR oTest := Test{}
oTest:DoSomething()
END USING
WriteLine("------------------")
WriteLine("After Using Block")
ReadKey()

CLASS Test IMPLEMENTS IDisposable

CONSTRUCTOR()
Console.WriteLine("Test:Constructor()")

METHOD DoSomething() AS VOID

Console.WriteLine("Test:DoSomething()")

METHOD Dispose() AS VOID

Console.WriteLine("Test:Dispose()")

END CLASS

1.8.6 CHECKED Example

FUNCTION Start() AS VOID

LOCAL d AS DWORD
LOCAL n AS INT

d := UInt32.MaxValue
? "Initial value of d:", d

BEGIN UNCHECKED
// arithmetic operations inside an UNCHECKED block will not produce
// overflow exceptions on arithmetic conversions and operations,
// no matter if overflow checking is enabled application-wide or not
n := (INT)d
? "Value of n after conversion:", n

© 2015- 2019 XSharp BV

 385 XSharp Bandol

d ++
? "Value of d after increasing it:", d
END UNCHECKED

d := UInt32.MaxValue
BEGIN CHECKED
// arithmetic operations inside a CHECKED block always do
// overflow checking and throw exceptions if overflow is detected
TRY
n := (INT)d
d ++
CATCH e AS Exception
? "Exception thrown in CHECKED operation:", e:Message
END TRY
END CHECKED
Console.ReadLine()
RETURN

1.8.7 EVENT Example

USING System.Collections.Generic
FUNCTION Start AS VOID
LOCAL e AS EventsExample
e := EventsExample{}
e:Event1 += TestClass.DelegateMethod
e:Event1 += TestClass.DelegateMethod
e:Event1 -= TestClass.DelegateMethod // added 2, removed 1, should be
called once
e:Event2 += TestClass.DelegateMethod
e:Event2 += TestClass.DelegateMethod
e:Event2 -= TestClass.DelegateMethod // added 2, removed 1, should be
called once
e:Event3 += TestClass.DelegateMethod
e:RaiseEvent1("This is a test through a multi line event definition")
e:RaiseEvent2("This is a test through a single line event definition")
e:RaiseEvent3("This is a test through an old style event definition")
Console.WriteLine("Press a Key")
Console.ReadLine()

DELEGATE EventHandler (s AS STRING) AS VOID

CLASS TestClass
STATIC METHOD DelegateMethod(s AS STRING ) AS VOID
Console.WriteLine( s)
END CLASS

CLASS EventsExample
PRIVATE eventsTable AS Dictionary<STRING, System.Delegate>
PRIVATE CONST sEvent1 := "Event1" AS STRING
PRIVATE CONST sEvent2 := "Event2" AS STRING
CONSTRUCTOR()
eventsTable := Dictionary<STRING, System.Delegate>{}

© 2015- 2019 XSharp BV

 X# Documentation 386

eventsTable:Add(sEvent1,NULL_OBJECT)
eventsTable:Add(sEvent2,NULL_OBJECT)

// Multiline definition
EVENT Event1 AS EventHandler
ADD
BEGIN LOCK eventsTable
eventsTable[sEvent1] := ((EventHandler)
eventsTable[sEvent1]) + value
END LOCK
Console.WriteLine(__ENTITY__ + " "+value:ToString())
END
REMOVE
BEGIN LOCK eventsTable
eventsTable[sEvent1] := ((EventHandler)
eventsTable[sEvent1]) - value
END LOCK
Console.WriteLine(__ENTITY__+ " "+value:ToString())
END
END EVENT

// Single Line defintion on multilpe lines with semi colons, for better
reading !
EVENT Event2 AS EventHandler ;
ADD eventsTable[sEvent2] := ((EventHandler)
eventsTable[sEvent2]) + value ;
REMOVE eventsTable[sEvent2] := ((EventHandler)
eventsTable[sEvent2]) - value

// Old style definition

EVENT Event3 AS EventHandler

METHOD RaiseEvent1(s AS STRING) AS VOID

VAR handler := (EventHandler) eventsTable[sEvent1]
IF handler != NULL
handler(s)
ENDIF

METHOD RaiseEvent2(s AS STRING) AS VOID

VAR handler := (EventHandler) eventsTable[sEvent2]
IF handler != NULL
handler(s)
ENDIF

METHOD RaiseEvent3(s AS STRING) AS VOID

IF SELF:Event3 != NULL
Event3(s)
ENDIF
END CLASS

© 2015- 2019 XSharp BV

 387 XSharp Bandol

1.8.8 Expression Examples

//
// This example shows various new expression formats
//
using System.Collections.Generic

Function Start() as void

VAR oNone := Person{"No", "Parent"}

FOREACH VAR oValue in GetList()

if oValue IS STRING // Value IS Type
? (String) oValue
ELSEIF oValue IS INT
? (Int) oValue
ELSEIF oValue IS DateTime
? (DateTime) oValue
ELSEIF oValue IS Person
LOCAL oPerson as Person
oPerson := (Person) oValue
? oPerson:FirstName, oPerson:LastName
// Value DEFAULT Value2 . When Value IS NULL then Value2 will be used
oPerson := oPerson:Parent DEFAULT oNone
? "Parent: ", oPerson:FirstName, oPerson:LastName
ENDIF
NEXT
LOCAL oEmptyPerson as Person
LOCAL sName as STRING
oEmptyPerson := GetAPerson()
sName := oEmptyPerson?:FirstName // Conditional Access: This
will not crash, even when Person is a NULL_OBJECT
? sName DEFAULT "None"
Console.ReadLine()
RETURN

FUNCTION GetList() AS List<OBJECT>

VAR aList := List<OBJECT>{}
aList:Add(DateTime.Now)
aList:Add("abcdefg")
aList:Add(123456)
VAR oPerson := Person{"John", "Doe"}
aList:Add(oPerson)
VAR oChild := Person{"Jane", "Doe"}
oChild:Parent := oPerson
aList:Add(oChild)
RETURN aList

CLASS Person
EXPORT FirstName AS STRING
EXPORT LastName as STRING
EXPORT Parent as Person
CONSTRUCTOR(First as STRING, Last as STRING)
FirstName := First
LastName := Last

END CLASS

© 2015- 2019 XSharp BV

 X# Documentation 388

FUNCTION GetAPerson() as Person

RETURN NULL_OBJECT

1.8.9 FIXED Example

The new FIXED modifier and BEGIN FIXED .. END FIXED keywords allow you to tell the
.Net runtime that you do not want a variable to be moved by the Garbage collector.

UNSAFE FUNCTION Start AS VOID

VAR s := "SDRS"
BEGIN FIXED LOCAL p := s AS CHAR PTR
VAR i := 0
WHILE p[i] != 0
p[i++]++
END
END FIXED
Console.WriteLine(s)
Console.Read()
RETURN

As you can see the BEGIN FIXED statement requires a local variable declaration. The
contents of this local (in the example above a CHAR PTR) will be excluded from garbage
collection inside the block.

Please note:
The FIXED keyword and the example above should be used with extreme care. Strings in
.Net are immutable. You normally should not manipulate strings this way !

1.8.10 GENERICs Example

Stack Example
This example shows that we can now create generic classes with X# !
In the Stack class the T parameter will be replaced with a type at compile time.

/*
Stack Example - Written by Robert van der Hulst
This example shows that we can now create generic classes with X# !
Note: Compile with the /AZ option
*/

USING System.Collections.Generic
USING STATIC System.Console

FUNCTION Start AS VOID

LOCAL oStack AS Stack<INT>
LOCAL i AS LONG
TRY
oStack := Stack<INT>{25}
WriteLine("Created a stack with {0} items",oStack:Capacity)
WriteLine("Pushing 10 items")

© 2015- 2019 XSharp BV

389 XSharp Bandol

FOR I := 1 TO 10
oStack:Push(i)
NEXT
WriteLine("Popping the stack until it is empty")
i := 0
WHILE oStack:Size > 0
i += 1
WriteLine(oStack:Pop())
END
WriteLine("{0} Items popped from the stack",i)
WriteLine("Press Enter")
ReadLine()
WriteLine("The next line pops from an empty stack and throws an
exception")
ReadLine()
WriteLine(oStack:Pop())
CATCH e AS Exception
WriteLine("An exception was catched: {0}", e:Message)
END TRY
WriteLine("Press Enter to Exit")
ReadLine()
RETURN

CLASS Stack<T> WHERE T IS STRUCT, NEW()

PROTECT _Items AS T[]
PROTECT _Size AS INT
PROTECT _Capacity AS INT
PROPERTY Size AS INT GET _Size
PROPERTY Capacity AS INT GET _Capacity

CONSTRUCTOR()
SELF(100)

CONSTRUCTOR(nCapacity AS INT)
_Capacity := nCapacity
_Items := T[]{nCapacity}
_Size := 0
RETURN

PUBLIC METHOD Push( item AS T) AS VOID

IF _Size >= _Capacity
THROW StackOverFlowException{}
ENDIF
_Items[_Size] := item
_Size++
RETURN

PUBLIC METHOD Pop( ) AS T

_Size--
IF _Size >= 0
RETURN _Items[_Size]
ELSE
_Size := 0
THROW Exception{"Cannot pop from an empty stack"}
ENDIF
END CLASS

© 2015- 2019 XSharp BV

 X# Documentation 390

1.8.11 Lamda Expressions

Lamda Expressions are very much like CodeBlocks, but the difference is that
it has optoinal typed parameters and return values.
You can also specify the parameter type in the parameter list as the 3rd
example shows

DELEGATE Multiply(x AS REAL8) AS REAL8

FUNCTION Start AS VOID
LOCAL del AS Multiply
del := {e => e * e}
? del(1)
? del(2)
? del(3)
? del(4)
Console.ReadLine()
LOCAL dfunc AS System.Func<Double,Double>
dfunc := {x =>
? "square of", x
RETURN x^2
}
? dfunc(5)
LOCAL typed AS Multiply
typed := {x AS REAL8 =>
? "square of", x
RETURN x^2
}
? typed(6)
RETURN

1.8.12 LINQ Example

The following example shows a couple of LINQ Queries in X#

USING System.Collections.Generic
USING System.Linq
USING STATIC System.Console

FUNCTION Start AS VOID

VAR oDev := GetDevelopers()
VAR oC := GetCountries()
VAR oAll := FROM D IN oDev ;
JOIN C IN oC ON D:Country EQUALS C:Name ;
ORDERBY D:LastName ;
SELECT CLASS {D:Name, D:Country, C:Region} //
Anonymous class !
// The type of oAll is
IOrderedEnumerable<<>f__AnonymousType0<Developer,Country>> // We prefer
the VAR keyword!

VAR oGreek := FROM Developer IN oDev ;

WHERE Developer:Country == "Greece" ;
ORDERBY Developer:LastName DESCENDING ;
SELECT Developer

© 2015- 2019 XSharp BV

391 XSharp Bandol

// The type of oGreek is IOrderedEnumerable<Developer>

// We prefer the VAR keyword!

VAR oCount := FROM Developer IN oDev ;

GROUP Developer BY Developer:Country INTO NewGroup ;
ORDERBY NewGroup:Key SELECT NewGroup
// The type of oCount is IOrderedEnumerable<<IGrouping<string,Developer>>
// We prefer the VAR keyword!

WriteLine(e"X# does LINQ!\n")

WriteLine(e"All X# developers (country+lastname order)\n")
FOREACH VAR oDeveloper IN oAll
WriteLine("{0} in {1}, {2}",oDeveloper:Name, oDeveloper:Country,
oDeveloper:Region)
NEXT

WriteLine(e"\nGreek X# Developers (descending lastname)\n")

FOREACH oDeveloper AS Developer IN oGreek
WriteLine(oDeveloper:Name)
NEXT

WriteLine(e"\nDevelopers grouped per country\n")

FOREACH VAR country IN oCount

WriteLine(i"{country.Key}, {country.Count()} developer(s)")
FOREACH VAR oDeveloper IN country
WriteLine(" " + oDeveloper:Name)
NEXT
NEXT
WriteLine("Enter to continue")
ReadLine()
RETURN

FUNCTION GetDevelopers AS IList<Developer>

// This function uses a collection initializer for the List of Developers
// and Object initializers for the Developer Objects
VAR oList := List<Developer>{} { ;
Developer{}{ FirstName := "Chris", LastName :=
"Pyrgas", Country := "Greece"},;
Developer{}{ FirstName := "Robert", LastName :=
"van der Hulst", Country := "The Netherlands"},;
Developer{}{ FirstName := "Fabrice", LastName :=
"Foray", Country := "France"},;
Developer{}{ FirstName := "Nikos", LastName :=
"Kokkalis", Country := "Greece"} ;
}
RETURN oList

FUNCTION GetCountries AS IList<Country>

// This function uses a collection initializer for the List of Counties
// and Object initializers for the Country Objects
VAR oList := List<Country>{}{ ;
Country{} {Name := "Greece", Region := "South
East Europe"},;
Country{} {Name := "France", Region := "West
Europe"},;

© 2015- 2019 XSharp BV

 X# Documentation 392

Country{} {Name := "The Netherlands", Region :=

"North West Europe"} ;
}
RETURN oList

CLASS Developer
PROPERTY Name AS STRING GET FirstName + " " + LastName
PROPERTY FirstName AS STRING AUTO
PROPERTY LastName AS STRING AUTO
PROPERTY Country AS STRING AUTO
END CLASS

CLASS Country
PROPERTY Name AS STRING AUTO
PROPERTY Region AS STRING AUTO
END CLASS

1.8.13 NOP Example

// The NOP keyword is an empty statement.

// This tells the compiler that there is no code missing !
FUNCTION Start() AS VOID
LOCAL i as LONG
FOR i := 1 to 10
IF I % 2 == 0
Console.WriteLine(i)
ELSE
NOP // Nothing happens here. This tells the compiler that there
is no code missing !
ENDIF
NEXT
RETURN

1.8.14 SWITCH Example

//
// The SWITCH statement is a replacement for the DO CASE statement
// The biggest difference is that the expression (in this case sDeveloper)
is only evaluated once.
// which will have a performance benefit over the DO CASE statement
// Empty statement lists for a CASE are allowed. In that case the labels
share the code (see CHRIS and NIKOS below)
//
// Please note that EXIT statements inside a switch are not allowed, however
RETURN, LOOP and THROW are allowed.
using System.Collections.Generic

Function Start() as void

© 2015- 2019 XSharp BV

 393 XSharp Bandol

FOREACH VAR sDeveloper in GetDevelopers()

SWITCH sDeveloper:ToUpper()
CASE "FABRICE"
? sDeveloper, "France"
CASE "CHRIS"
CASE "NIKOS"
? sDeveloper, "Greece"
CASE "ROBERT"
? sDeveloper, "The Netherlands"
OTHERWISE
? sDeveloper, "Earth"
END SWITCH
NEXT
Console.ReadKey()
RETURN

FUNCTION GetDevelopers as List<String>

VAR aList := List<String>{}
aList:AddRange(<string>{ "Chris", "Fabrice", "Nikos", "Robert" } )
RETURN aList

1.8.15 Typed Enums

Enums may now be typed in X#. The type indicates the base class for the ENUM. By
specifying a AS clause you can determine the size in bytes that the ENUM uses.

ENUM Foo AS BYTE

MEMBER One
MEMBER Two
END ENUM

1.8.16 USING Example

//
// XSharp allows you to not only use the using statement to link to
namespaces
// You can also link to a static class and call the methods in this class as
if they are functions.
// The functions WriteLine and ReadKey() in the following code are actually
resolved as System.Console.WriteLine()
// and System.Console.ReadKey()
// Finally there is also the BEGIN USING .. END USING construct which
controls the lifetime of a variable
// At the end of the block the Variable will be automatically disposed.
USING System
USING STATIC System.Console

FUNCTION Start() AS VOID

WriteLine("Before Using Block")

© 2015- 2019 XSharp BV

 X# Documentation 394

WriteLine("------------------")
BEGIN USING VAR oTest := Test{}
oTest:DoSomething()
END USING
WriteLine("------------------")
WriteLine("After Using Block")
ReadKey()

CLASS Test IMPLEMENTS IDisposable

CONSTRUCTOR()
Console.WriteLine("Test:Constructor()")

METHOD DoSomething() AS VOID

Console.WriteLine("Test:DoSomething()")

METHOD Dispose() AS VOID

Console.WriteLine("Test:Dispose()")

END CLASS

1.8.17 VAR Example

//
// The VAR keyword has been added to the language because in many situations
// the result of an expression will be directly assigned to a local, and the
expression
// will already describe the type of the variable
// VAR is a synonym for LOCAL IMPLIED in Vulcan
using System.Collections.Generic

FUNCTION Start AS VOID

// In the next line the compiler "knows" that today is a DateTime
VAR today := System.DateTime.Now
? today

// In the next line the compiler "knows" that text is a String

VAR text := Convert.ToString(123)
? text

// In the next line the compiler "knows" that s is a string

FOREACH VAR s in GetList()
? s
NEXT

Console.ReadLine()

RETURN

FUNCTION GetList AS List<String>

VAR aList := List<String>{}
aList:Add("abc")
aList:Add("def")

© 2015- 2019 XSharp BV

 395 XSharp Bandol

aList:Add("ghi")
return aList

1.8.18 Vulcan Runtime (BYOR)

This "Bring Your Own Runtime" (BYOR) example shows how you can use Vulcan
Datatypes
and functions in X#.

The example does NOT come with the Vulcan Runtime DLLs. You need to have
these installed
on your machine and you may need to update the references in the example and
point them
to the Vulcan Runtime DLLs on your machine.

// Please read the comments in Readme.txt !

using System
using System.Collections.Generic
using System.Linq
using System.Text

Function Start() as void

LOCAL startingColor AS ConsoleColor

startingColor := Console.ForegroundColor

ConsoleHeading("Bring Your Own Runtime (BYOR)

Sample",ConsoleColor.Magenta)
Console.ForegroundColor := ConsoleColor.Gray

DateSamples()
Conversion()
Strings()
Numeric()
Wait()
Arrays()
Symbols()
LateBinding()
Wait()

Workarea()
Wait()
Macros()
Wait()
CodeBlocks()
Wait()

Console.ForegroundColor := startingColor

FUNCTION ConsoleHeading(s AS STRING, c := ConsoleColor.Yellow AS

ConsoleColor) AS VOID
LOCAL originalColor AS ConsoleColor
originalColor := Console.ForegroundColor

© 2015- 2019 XSharp BV

 X# Documentation 396

Console.ForegroundColor := c
Console.WriteLine(s)
Console.ForegroundColor := originalColor

FUNCTION Wait() AS VOID

ConsoleHeading("Press any key to continue...",ConsoleColor.Green)
Console.ReadKey()

FUNCTION DateSamples() AS VOID

ConsoleHeading("Dates")
LOCAL dToday := Today() AS DATE
Console.WriteLine( i"Today is {dToday:d}" ) // Interpolated string,
short Date Format
Console.WriteLine( i"Today is {dToday:G}" ) // Interpolated string,
General Date Format

LOCAL dTomorrow AS __VODATE

dTomorrow := dToday + 1 // can perform VO date arithmetic
Console.WriteLine( i"Tomorrow is {dTomorrow:D}") // Long date format

LOCAL dNewYear AS DATE

dNewYear := 2016.01.01

Console.WriteLine("New year was " +AsString(dNewYear)+ " on a

"+CDOW(dNewyear))

FUNCTION Conversion() AS VOID

ConsoleHeading("Conversion")
LOCAL sToday AS STRING
sToday := DTOS(Today()) // Convert date using VO function
Console.WriteLine(i"Today is {sToday}")

FUNCTION Strings() AS VOID

ConsoleHeading("Strings")
LOCAL s AS STRING
LOCAL sToday := DTOS(Today())
s := SubStr(sToday,1,4) // string manipulation
Console.WriteLine(String.Format("SubStr is {0}",s))

LOCAL n AS DWORD
n := At("0",s)
Console.WriteLine(String.Format("At is {0}",n))

LOCAL c := "" AS STRING

Console.WriteLine(String.Format("c is {0}",IIF(Empty(c),"Empty","Not
empty")))
c := "x"
Console.WriteLine(String.Format("c is {0}",IIF(Empty(c),"Empty","Not
empty")))
RETURN

FUNCTION Numeric() as VOID

ConsoleHeading("Numeric")
LOCAL r AS REAL8
r := Pow(2,3)
Console.WriteLine(String.Format("Pow is {0}",r))

© 2015- 2019 XSharp BV

397 XSharp Bandol

LOCAL f AS FLOAT
f := Sqrt(10)
Console.WriteLine(String.Format("The root of 10 is {0}",f))
RETURN

FUNCTION Arrays() AS VOID

ConsoleHeading("Array")
LOCAL a AS ARRAY
a := {1,2,3}
Console.WriteLine(String.Format("Original Array length is {0}",ALen(a)))
AAdd(a,4)
AAdd(a,5)
AAdd(a,6)
Console.WriteLine(String.Format("Array length after adding 3 elements is
{0}",ALen(a)))
FOR VAR i := 1 TO ALen(a)
Console.Writeline(String.Format("{0} {1}", i, a[i]))
NEXT
ADel(a, 1)
Asize(a, Alen(a) -1)
Console.WriteLine(String.Format("Array length after deleting 1 elements
is {0}",ALen(a)))
RETURN

FUNCTION Symbols() AS VOID

LOCAL s as Symbol
LOCAL c as STRING
ConsoleHeading("Symbol")
s := #LastName
Console.WriteLine("Symbol s: "+s:ToString())
c := Symbol2String(s)
Console.WriteLine("Symbol converted to string : "+c)

RETURN

FUNCTION LateBinding() AS VOID

LOCAL e as Object
ConsoleHeading("Late binding")
e := Error{0, "Message"}
Console.WriteLine("Reading property from a untype variable")
Console.WriteLine( (String) e:Message)

RETURN

Function Workarea() AS VOID

LOCAL cWorkDir as STRING
FIELD LASTNAME, FIRSTNAME in CUSTOMER
ConsoleHeading("DBF Access")
cWorkDir := "..\..\"
SetPath(cWorkDir)
DbUseArea(TRUE, "DBFNTX","Customer")
DbSetIndex("CustNum.NTX")
DbSetIndex("CustName.NTX")
DbGoTop()
DO WHILE ! EOF()
? Str(Recno(),3), LASTNAME, FIRSTNAME, _FIELD->CITY
DbSkip(1)

© 2015- 2019 XSharp BV

 X# Documentation 398

ENDDO
DbCloseArea()

FUNCTION Macros() AS VOID

LOCAL cMacro as STRING
LOCAL cbMacro as CodeBlock
ConsoleHeading("Macros")
cMacro := "{||Today()}"
cbMacro := &(cMacro)
? cMacro, Eval(cbMacro)
cMacro := "1+2+3"
? cMacro, &cMacro
cMacro := "System.Int32.MaxValue"
cbMacro := MCompile(cMacro)
? cMacro, MExec(cbMacro)
cMacro := "{|a,b,c| a*b*c}"
cbMacro := &(cMacro)
? cMacro, Eval(cbMacro, 2,3,4)

?
RETURN

FUNCTION CodeBlocks() AS VOID

LOCAL oBlock as CodeBlock
ConsoleHeading("Codeblocks")
oBlock := {||Today()}
? oBlock, eval(oBlock)
oBlock := {||System.Math.Pow(2,3)}
? oBlock, eval(oBlock)
oBlock := {|a,b,c|a*b*c}
? oBlock, eval(oBlock,2,3,4)
?
RETURN

1.8.19 YIELD Example

using System.Collections.Generic

// The Yield return statement allows you to create code that returns a
// collection of values without having to create the collection in memory
first.
// The compiler will create code that "remembers" where you were inside the
// loop and returns to that spot.
FUNCTION Start AS VOID
FOREACH nYear AS INT IN GetAllLeapYears(1896, 2040)
? "Year", nYear, "is a leap year."
NEXT
Console.ReadLine()
RETURN

FUNCTION GetAllLeapYears(nMin AS INT, nMax AS INT) AS IEnumerable<INT>

FOR LOCAL nYear := nMin AS INT UPTO nMax
IF nYear % 4 == 0 .and. (nYear % 100 != 0 .or. nYear % 400 == 0)

© 2015- 2019 XSharp BV

399 XSharp Bandol

YIELD RETURN nYear

END IF
IF nYear == 2012
YIELD EXIT // Exit the loop
ENDIF
NEXT

© 2015- 2019 XSharp BV

 Index 400

.XOR. 265

Index -/-
/ 262
--- /* */
//
250
250
/= 264
- 262, 269
-- 269
-:-
-!- := 264

! 265
---
-#- -? 314

#command
#define 277
271
-@-
#else 278
#endif 279 @ compiler option 297
#endregion 281
#ifdef 279, 281
#ifndef 279
-^-
#include 280
#line 280 ^ 262
#LOAD 163 ^= 264
#pragma 280
#R
#region
163
281
-_-
#translate 281 __ARRAYBASE__ 250
#undef 287 __CLR2__ 250
#USING 249 __CLR4__ 250
__CLRVERSION__ 250
- %- __DATE__
__DATETIME__
250
250
% 262 __DEBUG__ 250
%= 264 __DIALECT__ 250
__DIALECT_CORE__ 250
__DIALECT_HARBOUR__ 250
-&- __DIALECT_VO__
__DIALECT_VULCAN__
250
250
& 266 __ENTITY__ 250
&& 250, 265 __FILE__ 250
&= 264 __FUNCTION__ 250
__LINE__ 250
-*- __MODULE__
__SIG__ 250
250

__SRCLOC__ 250
* 262 __SYSDIR__ 250
** 262 __TIME__ 250
*= 264 __UTCTIME__ 250
__VERSION__ 250
-.- __VO1__
__VO10__
250
250
__VO11__ 250
.AND. 265, 266 __VO12__ 250
.NOT. 265 __VO13__ 250
.OR. 265, 266 __VO14__ 250
.PRGX 163 __VO15__ 250

© 2015- 2019 XSharp BV

 401 XSharp Bandol

__VO2__ 250
__VO3__
__VO4__
250
250 ->-
__VO5__ 250
__VO6__ 250 > 267
__VO7__ 250
__VO8__
__VO9__
250
250
---
__WINDIR__ 250
-> 270
__WINDRIVE__ 250
__XSHARP__ 250
_ARGS
_DLL
252
220
->-
_DLL FUNCTION 220 >= 267
_DLL PROCEDURE 220 >> 269
_FIELD 270 >>= 264
_GETFPARAM 252
_GetInst
_GETMPARAM
252
252 -A-
_WINCALL 250
-a 300
-|- ABSTRACT 221
ACCESS 215
ADD 97, 214
| 266 -additionalfile 299
|| 265 -addmodule 299
|= 264 ALIAS 270
alias operator 270
-~- ALTD
-analyzer
252
300
-appconfig 300
~ 266
ARGCOUNT 252
~= 264
ARRAY 161, 205
ARRAY OF 159
-+- AS 230, 260
ASCENDING 260
+ 262, 269 ASSIGN 215
++ 269 assignment operator 264
+= 264 ASYNC 221, 226
Attributes 220

-<- AWAIT 226

-az 302

<
<<
267
269 -B-
<<= 264
<= 267 -baseaddress 303
BEGIN 90, 91, 92, 226, 227, 249

-=- BEGIN FIXED

BEGIN LOCK
226
226
BEGIN NAMESPACE 333
= 264 BEGIN SCOPE 227
BEGIN SEQUENCE 227
--- BEGIN UNSAFE
BEGIN USING
227
227
binary operators 262
-= 264 bitwise operator 266
BREAK 227
-=- BY
BYTE
260
202
=> 390

© 2015- 2019 XSharp BV

 Index 402

ENDDO 229
-C- ENDIF
Entities
231
181
ENUM 209, 333, 393
CASE 227, 242 EQUALS 260
CATCH 242 -errorendlocation 311
CCALL 252 -errorreport 312
CCallNative 252 EVENT 97, 214
Char 203, 244 EXIT 108, 229
CHECKED 90, 226 EXPLICIT 215
-checked 303, 314, 337 EXPORT 221
-checksumalgorithm 304 Expression Statement 223
CLASS 209, 333 EXTERN 221
Click here for the version history 9
Clipper
CODEBLOCK
250, 267
161, 206 -F-
-codepage 305
'compatible string comparions 267 FASTCALL 250
Compiler Options 287, 289, 294 FIELD 217, 229, 270
CONST 209 -filealign 313
CONSTRUCTOR 213 FINALLY 227, 242
-cs 305 FIXED 91, 226
FLOAT 161, 207
-D- FOR
FOREACH
230
230
-fovf 314
-d 306 foxpro 310
Date 161, 207, 246 FROM 260
dbase 310 -fullpaths 314
-debug 306 FUNCTION 218
DECLARE 213
DEFAULT 96, 242
DEFINE 219 -G-
-define 308
-delaysign 309 GAC 158
DELEGATE 209, 333 Generic 95
DESCENDING 260 GET 216
DESTRUCTOR 214 GLOBAL 209
-dialect 310 GROUP 260
DIM 209
DO
DO CASE
229
227 -H-
-doc 310
DOWNTO 230 Harbour 310
DWORD 203 -help 314
DYNAMIC 203 HIDDEN 221
dynamic memory variable 270 -highentropyva 315

-E- -I-
ei"..." 102 -i 315
ELSE 231 i"..." 102
ELSEIF 231 ie"..." 102
END 209, 211, 226, 227, 229, 231, 242, 249 IF 231
END CASE 227 IMPLEMENTS 209, 212
END FIXED 226 IMPLICIT 215
END LOCK 226 IMPLIED 230, 231
END SCOPE 227 IN 229, 230, 260
END SEQUENCE 227 INHERIT 209
END UNSAFE 227 -ins 316
END USING 227 Installation 158
ENDCASE 227 INSTANCE 217

© 2015- 2019 XSharp BV

 403 XSharp Bandol

INT 203 NULL 246

INT64 203 NULL_ARRAY 246
INTERFACE 211, 333 NULL_CODEBLOCK 246
INTERNAL 221 NULL_DATE 246
Interpolated 102 NULL_OBJECT 246
INTO 260 NULL_PSZ 246
IS 100 NULL_PTR 246
item templates 171 NULL_STRING 246
NULL_SYMBOL 246
-J- -O-
JOIN 260
OBJECT 204
-K- ON 260
operator 215, 262, 264, 265, 266, 267, 269, 270
-optimize 335
-keycontainer 317 options 280, 287, 289, 294
-keyfile 318, 349 ORDERBY 260
Ordinal 267
-L- OTHERWISE
OUT 222
227, 242

-out 336
Lamda 390
OVERRIDE 221
Lamda Expression 390
-ovf 337
-langversion 319
-lb 319
LET 260
-lib 321
-P-
-link 322 -parallel 337
-linkresource 324 Parameters 181
LINQ 103 PASCAL 250
LOCAL 230, 231 -pathmap 337
LOCK 226 PCALL 252
Logic 161, 204, 246 PCallNative 252
logical operator 265 PCOUNT 252
LONG 203 -pdb 338
LONGINT 203 -platform 338
LOOP 235 -ppo 340
pragma 280
-M- -preferreduilang
Preprocessor
340
271, 277, 278, 279, 280, 281,
-main 326 287
MEMBER 209, 212 PRGX 163
MEMVAR 235 PRIVATE 221, 237
METHOD 215 PROCEDURE 218
-moduleassemblyname 327 project templates 169
-modulename 329 PROPERTY 216
PROTECTED 221
PSZ 162, 207
-N- PTR
PUBLIC
204
221, 239
NAMESPACE 218, 249
NameSpaces
NEXT 230
249
-R-
-noconfig 330
-nologo 330 REAL4 204
NOP 105, 236 REAL8 204
-nostddefs 331 RECOVER 227
-nostdlib 331 -recurse 341
-nowarn 332 REF 222
-nowin32manifest 332 -reference 342
-ns 333 -refonly 344

© 2015- 2019 XSharp BV

 Index 404

-refout 345 UNTIL 241

relational operator 267 UPTO 230
REMOVE 97, 214 USING 92, 107, 219, 227, 249
REPEAT 241 USUAL 162, 208
-resource 346 -utf8output 354
RETURN 108, 241
-ruleset
Runtime
347
158 -V-
Runtime chapter 10
VAR 108, 230

-S- VIRTUAL
vo 310
221

-vo1 354
-s 347 -vo10 355
SCOPE 227 -vo11 356
scripting 163 -vo12 356
SEALED 221 -vo13 267, 357
SELECT 260 -vo14 359
SELF 213 -vo15 360
SEQUENCE 227 -vo2 362
SET 216 -vo3 363
SetCollation 267 -vo4 364
shift operator 269 -vo5 366
SHORT 205 -vo6 367
SHORTINT 205 -vo7 369
-showdefs 348 -vo8 371
-showincludes 348 -vo9 373
SLen 252 VOID 205
-snk 349 VOSTRUCT 212, 333
STATIC 209, 221, 231, 249 vulcan 310
-stddefs 349
STEP
STRICT 250
230
-W-
STRING 102, 205
STRUCT 212 -w 374
STRUCTURE 212, 333 -warn 374
-subsystemversion 349 -warnaserror 375, 379
SUPER 213 warnings 280
SWITCH 106, 242 WHERE 260
SYMBOL 162, 205, 207 WHILE 229
-win32icon 376

-T- -win32manifest
-win32res 378
377

Windows 267
-target 351 WORD 205
templates 169, 171 workarea 270
THISCALL 250 -wx 379
THROW 242
TO 230
-touchedfiles 352 -X-
TRY 242
Typed Enums 393 xBase++ 310
-xpp1 379

-U- XS9082 10
XSharp.__Array 161
XSharp.__ArrayBase 159
unary operator 269 XSharp.__Date 161
UNCHECKED 91, 226 XSharp.__Float 161
Unicode 267 XSharp.__Psz 162
UNION 212 XSharp.__Symbol 162
UNIT64 205 XSharp.__Usual 162
UNSAFE 92, 221, 227 XSharp.__WinBool 161
-unsafe 353 XSharp._CodeBlock 161

© 2015- 2019 XSharp BV

 405 XSharp Bandol

XSharp.CodeBlock 161
XSharp.Core 154
XSharp.Macrocompiler 156
XSharp.Macrocompiler.Full.DLL 156
XSharp.RDD 157
XSharp.RT 154
XSharp.VFP 155
XSharp.VO 155
XSharp.XPP 155
XSharpScript 163
xsi.exe 163

-Y-
YIELD 108, 242
YIELD BREAK 242
YIELD EXIT 242
YIELD RETURN 243

© 2015- 2019 XSharp BV

Back Cover