Skip to content

Commit

Permalink
fbdocs: wiki snapshot 2022.02.06
Browse files Browse the repository at this point in the history
  • Loading branch information
jayrm committed Feb 6, 2022
1 parent 86d9b2f commit aadc065
Show file tree
Hide file tree
Showing 40 changed files with 1,707 additions and 50 deletions.
4 changes: 2 additions & 2 deletions doc/manual/cache/CatPgOpMemory.wakka
Expand Up @@ -12,6 +12,6 @@ The memory operators provide a way to dynamically allocate and deallocate variab
<<>>=={{fbdoc item="keyword" value="KeyPgOpDelete|Operator Delete Statement"}}==
Destroys and deallocates memory for objects.
=={{fbdoc item="keyword" value="KeyPgOpDeleteOverload|Operator Delete Overload"}}==
Overloads memory deallocation process of Operator Delete Statement when applying to UDT.>>::c::

Overloads memory deallocation process of Operator Delete Statement when applying to UDT.
>>::c::
{{fbdoc item="back" value="CatPgOperators|Operators"}}
1 change: 1 addition & 0 deletions doc/manual/cache/CatPgProgrammer.wakka
Expand Up @@ -133,6 +133,7 @@
{{fbdoc item="keyword" value="ProPgErrorHandling|Error Handling"}}
{{fbdoc item="keyword" value="ProPgEventHandling|Event Handling"}}
{{fbdoc item="keyword" value="CatPgDddefines|Intrinsic Defines"}}
{{fbdoc item="keyword" value="ProPgIdentifierLookup|Identifier Look-ups in namespaces and types"}}

NOTE: Existing ""CatPg"" pages should be recreated as ""ProPg"" pages providing a general overview to the grouping of keywords.
>>::c::
Expand Down
4 changes: 2 additions & 2 deletions doc/manual/cache/DevToc.wakka
Expand Up @@ -27,7 +27,7 @@ This area of the Wiki is for documenting everything about the compiler and the r
{{fbdoc item="keyword" value="DevHeaderStyleGuide|Header Style Guidelines"}}
{{fbdoc item="keyword" value="ExtLibTOC|External Libraries Index (header status)"}}

{{fbdoc item="section" value="Compiler internals"}}
<<>>{{fbdoc item="section" value="Compiler internals"}}

{{fbdoc item="keyword" value="DevFbcModules|Quick overview of all modules"}}
{{fbdoc item="keyword" value="DevObjinfo|The objinfo feature"}}
Expand All @@ -51,6 +51,6 @@ This area of the Wiki is for documenting everything about the compiler and the r
{{fbdoc item="keyword" value="GfxLib|Overview of drivers (backends)"}}
{{fbdoc item="keyword" value="GfxInternalFormats|Pixel formats"}}

<<::c::
>>::c::

{{fbdoc item="back" value="DocToc|Table of Contents"}}
25 changes: 11 additions & 14 deletions doc/manual/cache/KeyPgAsc.wakka
@@ -1,5 +1,5 @@
{{fbdoc item="title" value="ASC"}}----
Returns the corresponding ASCII or Unicode integer representation of a character
Returns the corresponding ASCII or Unicode integer representation of a character.

{{fbdoc item="syntax"}}##
[[KeyPgDeclare|declare]] [[KeyPgFunction|function]] **Asc** ( [[KeyPgByref|byref]] //str// [[KeyPgAs|as]] [[KeyPgConstQualifier|const]] [[KeyPgString|string]], [[KeyPgByval|byval]] //position// [[KeyPgAs|as]] [[KeyPgInteger|integer]] = 1 ) [[KeyPgAs|as]] [[KeyPgUlong|ulong]]
Expand Down Expand Up @@ -29,24 +29,21 @@ Returns the corresponding ASCII or Unicode integer representation of a character
##[[KeyPgChr|Chr]]## performs the opposite function for ASCII strings, while ##[[KeyPgWchr|WChr]]## is the opposite for Unicode strings, returning a string containing the character represented by the code passed as an argument.

{{fbdoc item="ex"}}
{{fbdoc item="filename" value="examples/manual/strings/asc.bas"}}%%(freebasic)
{{fbdoc item="filename" value="examples/manual/strings/asc.bas"}}%%(freebasic)
print "the ascii code of 'a' is:"; asc("a")
print "the ascii code of 'b' is:"; asc("abc", 2)
%%
will produce the output:

%%the ascii code of 'a' is: 97
will produce the output:
%%the ascii code of 'a' is: 97
the ascii code of 'b' is: 98
%%

Unicode example (Note to documentation editors: don't put inside ""%%(qbasic)"" markers or the Russian text will disappear!)

<<##dim a as wstring * 12
a = "&#1055;&#1088;&#1080;&#1074;&#1077;&#1090;, &#1084;&#1080;&#1088;"
print "the Unicode of the second char of " & a & " is: " & asc(a, 2)
##<<::c:: will produce the output:
<<##the Unicode of the second char of &#1055;&#1088;&#1080;&#1074;&#1077;&#1090;, &#1084;&#1080;&#1088; is: 1088
##<<::c::
Unicode example (Note to documentation editors: don't put inside ""%%(qbasic)"" markers or the Russian text will disappear!)
<<##dim a as wstring * 12
a = "&#1055;&#1088;&#1080;&#1074;&#1077;&#1090;, &#1084;&#1080;&#1088;"
print "the Unicode of the second char of " & a & " is: " & asc(a, 2)##<<
::c::will produce the output:
<<##the Unicode of the second char of &#1055;&#1088;&#1080;&#1074;&#1077;&#1090;, &#1084;&#1080;&#1088; is: 1088##<<
::c::
{{fbdoc item="target"}}
- DOS does not support the wide-character string version of ##**ASC**##.

Expand Down
7 changes: 2 additions & 5 deletions doc/manual/cache/KeyPgPpPragma.wakka
Expand Up @@ -11,9 +11,7 @@ Preprocessor directive
{{fbdoc item="param"}}
Possible values for ##//option//## and related ##//value//##s:

{{table columns="3" cellpadding="1" cells="Option; Value; Description; msbitfields; false; Use bitfields compatible with gcc (default); msbitfields; true ; Use bitfields compatible with those used in Microsoft C compilers; once; N/A; cause the source file in which the pragma ppears to behave as though it was included with #include once ...; constness; false; disable 'CONST qualifier discarded' warning in current source; constness; true; enable 'CONST qualifier discarded' warning in current source; lookup108; false; use normal symbol lookups for unqualified symbol names; lookup108; true; use fbc-1.08.x or earlier symbol lookups for unqualified symbol names;"
}}

{{table columns="3" cellpadding="1" cells="Option; Value; Description; msbitfields; false; Use bitfields compatible with gcc (default); msbitfields; true ; Use bitfields compatible with those used in Microsoft C compilers; once; N/A; cause the source file in which the pragma ppears to behave as though it was included with #include once ...; constness; false; disable 'CONST qualifier discarded' warning in current source; constness; true; enable 'CONST qualifier discarded' warning in current source; lookup108; false; use normal symbol lookups for unqualified symbol names; lookup108; true; use fbc-1.08.x or earlier symbol lookups for unqualified symbol names"}}
If //value// is not given, the compiler assumes //True// (//-1//). A zero (//0//) value may be used in place of //False//. A non-zero (for example, //-1//) value may be used in place of //True//.

{{fbdoc item="desc"}}
Expand All @@ -24,7 +22,7 @@ Preprocessor directive
**##constness##** pragma is added for testing fbc compiler. It will be removed in future at should not be relied upon.

{{fbdoc item="ex"}}
{{fbdoc item="filename" value="examples/manual/prepro/pragma.bas"}}%%(freebasic)
{{fbdoc item="filename" value="examples/manual/prepro/pragma.bas"}}%%(freebasic)
'' MSVC-compatible bitfields: save the current setting and then enable them
#pragma push(msbitfields)

Expand All @@ -33,7 +31,6 @@ Preprocessor directive
'' restore original setting
#pragma pop(msbitfields)
%%

{{fbdoc item="ver"}}
- //#pragma lookup108// added in version 1.09.0, and to be removed in next minor release

Expand Down
8 changes: 5 additions & 3 deletions doc/manual/cache/KeyPgPrintusing.wakka
@@ -1,5 +1,5 @@
{{fbdoc item="title" value="(PRINT | ?) USING"}}----
Outputs formatted text to the screen or output device
Outputs formatted text to the screen or output device.

{{fbdoc item="syntax"}}##
([[KeyPgPrint|Print]] | [[KeyPgPrint|?]]) [# //filenum// ,] [ //printexpressionlist// {,|;} ] **Using** //formatstring// **;** [ //expressionlist// [ ; ] ]
Expand All @@ -23,7 +23,9 @@ Outputs formatted text to the screen or output device

{{fbdoc item="section" value="String formatting"}}

{{table columns="2" cellpadding="2" cells="Marker;Formatting;!;prints the first character of a string;\ \;prints as many characters of a string as occupied between the pair \ \;&amp;;prints the entire string"}}
{{table columns="2" cellpadding="2" cells="Marker;Formatting;!;prints the first character of a string;\ \;prints two or more characters of a string - as many as are occupied by the backslashes ('\') and any enclosed space characters (' ');&amp;;prints the entire string"}}

If an exact amount of characters is specified (with ##"!"## or ##"\ \"##), the string will be truncated or padded with spaces on the right as needed to output that many characters.

{{fbdoc item="section" value="Numeric formatting"}}

Expand Down Expand Up @@ -62,4 +64,4 @@ The last day in the year is 31 Dec%%
- ##[[KeyPgUsing|Using]]##
- ##[[KeyPgPalette|Palette Using]]##

{{fbdoc item="back" value="CatPgConsole|Console Functions"}}
{{fbdoc item="back" value="CatPgConsole|Console Functions"}}
1 change: 1 addition & 0 deletions doc/manual/cache/PrintToc.wakka
Expand Up @@ -913,6 +913,7 @@
[[ProPgErrorHandling|Error Handling]]
[[ProPgEventHandling|Event Handling]]
[[CatPgDddefines|Intrinsic Defines]]
[[ProPgIdentifierLookup|Identifier Look-ups in namespaces and types]]
[[CommunityTutorials|Community Tutorials]]
[[CodeLibrary|Community Code Library]]

Expand Down

0 comments on commit aadc065

Please sign in to comment.