fbdocs: wiki snapshot 2020.12.31

Author: jayrm

doc/manual/cache/CatPgCompOpt.wakka

@@ -110,7 +110,7 @@ Command line compiler options for the fbc compiler:
 	{{fbdoc item="keyword" value="CompilerOptstrip|-strip"}}
 		- Omit all symbol information from the output file
 	{{fbdoc item="keyword" value="CompilerOptt|-t < value >"}}
-		- Set stack size in kbytes (default: 1M)
+		- Set stack size in kbytes (default: 1 MB or 2 MB)
 	{{fbdoc item="keyword" value="CompilerOpttarget|-target < platform >"}}
 		- Set the target platform for cross compilation
 	{{fbdoc item="keyword" value="CompilerOptv|-v"}}

doc/manual/cache/CompilerCmdLine.wakka

@@ -146,7 +146,7 @@ Using the **fbc** command-line.
 	=={{fbdoc item="keyword" value="CompilerOpts|-s < name >"}}==
 		Set subsystem (##gui##, ##console##)
 	=={{fbdoc item="keyword" value="CompilerOptt|-t < value >"}}==
-		Set stack size in kbytes (default: 1M)
+		Set stack size in kbytes (default: 1 MB or 2 MB)
 
 {{fbdoc item="section" value="Meta"}}
 	=={{fbdoc item="keyword" value="CompilerOptoptfile|@< file >"}}==

doc/manual/cache/CompilerFAQ.wakka

@@ -186,7 +186,7 @@
 		- defining the array with an empty subscript list (using ##[[KeyPgDim|Dim]]##), or
 		- defining the array with variable subscripts instead of numeric literals, [[KeyPgConst|constants]] or [[KeyPgEnum|enums]] (using ##[[KeyPgDim|Dim]]##), or
 		- defining the array with ##[[KeyPgRedim|Redim]]##
-	- reserve more memory for the program stack by using the ##-t## [[CompilerCmdLine|command-line option]] when compiling. The default is ##-t 1024## (kilobytes). Note: it's a bad idea to use very large values here.
+	- reserve more memory for the program stack by using the ##-t## [[CompilerCmdLine|command-line option]] when compiling. The default is ##-t 1024## (kilobytes) or ##-t 2048## (kilobytes). Note: it's a bad idea to use very large values here.
 	- create a //static// array by defining the array with ##[[KeyPgStatic|Static]]## rather than ##[[KeyPgDim|Dim]]## (only locally visible, but globally preserved)
 	- define the array with ##[[KeyPgShared|Shared]]## access using ##[[KeyPgDim|Dim]]## (this makes the array fully global)
 	- use [[ProPgPointers|Pointers]] and [[CatPgMemory|Memory Functions]] like ##[[KeyPgAllocate|Allocate]]## and ##[[KeyPgDeallocate|Deallocate]]## to manage memory yourself - this is the preferred way for storing big buffers, but not for beginners.

doc/manual/cache/CompilerOptt.wakka

@@ -9,7 +9,7 @@ Set stack size in kilobytes
 		Stack size in kilobytes.
 
 {{fbdoc item="desc"}}
-	The ##-t## compiler option sets the stack size in kilobytes (defaults to 1024 KBytes). The local arrays are created in the stack, so 1MB of stack is not always enough.
+	The ##-t## compiler option sets the stack size in kilobytes (defaults to 1024 KBytes for 32-bit targets, increased to 2048 KBytes for 64-bit targets if fbc version >= 1.08). The local arrays are created in the stack, so 1 MB or 2 MB of stack is not always enough.
 
 {{fbdoc item="target"}}
 	- Supported on Windows, Cygwin and DOS only.

doc/manual/cache/FBWiki.wakka

@@ -31,8 +31,8 @@ Hello, and welcome to the ""FreeBASIC"" wiki. ""FreeBASIC"" is free, open source
 
 ==How to get involved in FB development==
 
-	Getting involved in ""FreeBASIC""'s development isn't hard. You can provide feedback, help improving this wiki or help developing ""FreeBASIC""-related projects. Of course you can also contribute to the ""FreeBASIC"" compiler, by reporting bugs or submitting patches. A good way to get started is to write small patches and submitting them via the patch tracker on ""SourceForge"", or posting them on the forum. Besides the compiler (written in ""FreeBASIC"" itself), there is the runtime library as well as the graphics library (both written in C). Feel free to contact other developers via the forum, the ""##freebasic"" IRC channel on freenode, or the trackers on ""SourceForge"".
-	
+	Getting involved in ""FreeBASIC""'s development isn't hard. You can provide feedback, help improving this wiki or help developing ""FreeBASIC""-related projects. Of course you can also contribute to the ""FreeBASIC"" compiler, by reporting bugs or submitting patches. A good way to get started is to write small patches and submitting them via the patch tracker on ""SourceForge"", or posting them on the forum. Besides the compiler (written in ""FreeBASIC"" itself), there is the runtime library as well as the graphics library (both written in C). Feel free to contact other developers via the forum, the ""##freebasic"" IRC channel on freenode, or the trackers on ""SourceForge"".  [[https://discord.gg/286rSdK|Join the discussion on Discord]]
+
 	[[CompilerContacting|How to contact the developers]]
 	[[CompilerReportingBugs|How to report a bug]]
 	[[DevToc|FreeBASIC Internals Documentation]]

doc/manual/cache/KeyPgFBArray.wakka

@@ -101,7 +101,7 @@ end namespace
 
 			##FBARRAY_FLAGS_DIMENSIONS## : a 4 bit field to indicate the number of elements allocated in ##dimTb()##.  If fbc can determine at compile time that less than ##FB_MAXDIMENSIONS## are needed to represent the array, then only the number of dimensions needed are allocated in ##dimTb()##.
 
-			##FBARRAY_FLAGS_FIXED_DIM## : if this bit is set, indicates that the number of dimensions are are set and are given in ##dimTb()## and must not be changed.
+			##FBARRAY_FLAGS_FIXED_DIM## : if this bit is set, indicates that the number of dimensions are set and are given in ##dimTb()## and must not be changed.
 
 			##FBARRAY_FLAGS_FIXED_LEN## : if this bit is set, indicates that the array data is fixed length and must not be resized or reallocated
 

doc/manual/cache/KeyPgThreadSelf.wakka

@@ -50,34 +50,30 @@ Sleep
 #include "fbthread.bi"
 
 Dim As Any Ptr phandle(1 To 10)
-Dim Shared As Any Ptr pmutex0
 Dim Shared As Any Ptr pmutex
 
-Sub myThread (Byval p As Any Ptr)
-	Mutexlock(pmutex0)  ' to ensure that ThreadCreate line is completed before accessing the handle value
-	Dim As Any Ptr phandle1 = *Cptr(Any Ptr Ptr, p)
-	Mutexunlock(pmutex0)
+Sub myThread (ByVal p As Any Ptr)
+	MutexLock(pmutex)  ' to ensure that ThreadCreate line is completed before accessing the handle value
+	Dim As Any Ptr phandle1 = *CPtr(Any Ptr Ptr, p)
+	MutexUnlock(pmutex)
 	Dim As Any Ptr phandle2 = Threadself()
-	Mutexlock(pmutex)
-	Print "   ThreadCreate: " & phandle1, "ThreadSelf: " & phandle2
-	Mutexunlock(pmutex)
+	Print Left("   ThreadCreate: " & phandle1 & Space(18), 36) _
+		  & "   ThreadSelf: " & phandle2  ' single print with concatenated string avoids using a mutex
 	Sleep 100, 1
 End Sub
 
 Print "Handles returned from:"
-pmutex0 = Mutexcreate()
-pmutex = Mutexcreate()
+pmutex = MutexCreate()
 For I As Integer = 1 To 10
-	Mutexlock(pmutex0)  ' to ensure that ThreadCreate line is completed before thread accesses the handle value
-	phandle(I) = Threadcreate(@myThread, @phandle(I))
-	Mutexunlock(pmutex0)
+	MutexLock(pmutex)  ' to ensure that ThreadCreate line is completed before thread accesses the handle value
+	phandle(I) = ThreadCreate(@myThread, @phandle(I))
+	MutexUnlock(pmutex)
 Next I
 
 For I As Integer = 1 To 10
-	Threadwait(phandle(I))
+	ThreadWait(phandle(I))
 Next I
-Mutexdestroy(pmutex0)
-Mutexdestroy(pmutex)
+MutexDestroy(pmutex)
 
 Sleep
 	%%

doc/manual/cache/PrintToc.wakka

@@ -832,6 +832,7 @@
 		[[ProPgCtorsDtors|Constructors and Destructors (basics)]]
 		[[ProPgMemberProcedures|Member Procedures]]
 		[[ProPgProperties|Properties]]
+		[[ProPgVariableLengthData|Variable-length member data]]
 		[[ProPgMemberAccessRights|Member Access Rights and Encapsulation]]
 		[[ProPgOperatorOverloading|Operator Overloading]]
 		[[ProPgTypeIterators|Iterators]]
@@ -875,6 +876,7 @@
 		[[ProPgMtCriticalSectionsFAQ|Critical Sections FAQ]]
 
 	{{fbdoc item="subsect" value="Making Binaries"}}
+		[[ProPgExecutables|Executables]]
 		[[ProPgStaticLibraries|Static Libraries]]
 		[[ProPgSharedLibraries|Shared Libraries (DLLs)]]
 		[[ProPgProfiling|Profiling]]

doc/manual/cache/ProPgDynamicMemory.wakka

@@ -17,7 +17,7 @@ Managing **Dynamic Memory** (Allocation / Deallocation) with **""FreeBASIC""**
 	If the size of everything must be declared at compile time, the best is try to estimate the maximum size of the variables needed and hope this will be enough.
 	This is a bad solution for at least third reasons:
 		**""-""** First, it leads to wasting memory if it is not fully used.
-		**""-""** Second, most normal variables are allocated in a part of the memory called the stack. The amount of stack memory for a program is usually quite low (1 MB by default). If exceeding this number, the stack overflow will occur, and the program will abort.
+		**""-""** Second, most normal variables are allocated in a part of the memory called the stack. The amount of stack memory for a program is usually quite low (1 MB or 2 MB by default). If exceeding this number, the stack overflow will occur, and the program will abort.
 		**""-""** Third, and most importantly, this can lead to artificial limitations and / or overflows. What happens if the required memory becomes greater than the reserved memory (stopping the program, emitting message to user, ...).
 
 	Fortunately, these problems are easily solved through the dynamic allocation of memory. Dynamic memory allocation is a way of running programs to request memory from the operating system when needed. This memory does not come from the program's limited stack memory, but it is rather allocated from a much larger memory pool managed by the operating system called heap. On modern machines, the heap can have a size of several gigabytes.

examples/manual/threads/threadsself-handles.bas

@@ -9,33 +9,29 @@
 #include "fbthread.bi"
 
 Dim As Any Ptr phandle(1 To 10)
-Dim Shared As Any Ptr pmutex0
 Dim Shared As Any Ptr pmutex
 
 Sub myThread (ByVal p As Any Ptr)
-	MutexLock(pmutex0)  ' to ensure that ThreadCreate line is completed before accessing the handle value
+	MutexLock(pmutex)  ' to ensure that ThreadCreate line is completed before accessing the handle value
 	Dim As Any Ptr phandle1 = *CPtr(Any Ptr Ptr, p)
-	MutexUnlock(pmutex0)
-	Dim As Any Ptr phandle2 = Threadself()
-	MutexLock(pmutex)
-	Print "   ThreadCreate: " & phandle1, "ThreadSelf: " & phandle2
 	MutexUnlock(pmutex)
+	Dim As Any Ptr phandle2 = ThreadSelf()
+	Print Left("   ThreadCreate: " & phandle1 & Space(18), 36) _
+		  & "   ThreadSelf: " & phandle2  ' single print with concatenated string avoids using a mutex
 	Sleep 100, 1
 End Sub
 
 Print "Handles returned from:"
-pmutex0 = MutexCreate()
 pmutex = MutexCreate()
 For I As Integer = 1 To 10
-	MutexLock(pmutex0)  ' to ensure that ThreadCreate line is completed before thread accesses the handle value
+	MutexLock(pmutex)  ' to ensure that ThreadCreate line is completed before thread accesses the handle value
 	phandle(I) = ThreadCreate(@myThread, @phandle(I))
-	MutexUnlock(pmutex0)
+	MutexUnlock(pmutex)
 Next I
 
 For I As Integer = 1 To 10
 	ThreadWait(phandle(I))
 Next I
-MutexDestroy(pmutex0)
 MutexDestroy(pmutex)
 
 Sleep