fbdocs: update examples/manual from wiki

jayrm · jayrm · commit 1e99fab10eb0 · 2021-06-28T21:44:46.000-04:00
diff --git a/examples/manual/gfx/cls-memset.bas b/examples/manual/gfx/cls-memset.bas
@@ -7,7 +7,7 @@
 '' --------
 
 Dim scrbuf As Byte Ptr, scrsize As Integer
-Dim As Integer scrhei, scrpitch
+Dim As Long scrhei, scrpitch
 Dim As Integer r = 0, dr = 1
 
 ScreenRes 640, 480, 8
diff --git a/examples/manual/gfx/imageconvertrow.bas b/examples/manual/gfx/imageconvertrow.bas
@@ -48,7 +48,7 @@ Sleep
 
 '' copy the image data into a 32-bit image
 Dim As Byte Ptr p8, p32
-Dim As Integer pitch8, pitch32
+Dim As Long pitch8, pitch32
 
 #ifndef ImageInfo '' older versions of FB don't have the ImageInfo feature
 #define GETPITCH(img_) IIf(img_->Type=PUT_HEADER_NEW,img_->pitch,img_->old.width*img_->old.bpp)
diff --git a/examples/manual/gfx/imageinfo.bas b/examples/manual/gfx/imageinfo.bas
@@ -10,7 +10,7 @@
 ScreenRes 320, 200, 32
 Dim image As Any Ptr = ImageCreate( 64, 64 )
 
-Dim pitch As Integer
+Dim pitch As Long
 Dim pixels As Any Ptr
 
 '' Get enough information to iterate through the pixel data.
diff --git a/examples/manual/gfx/screenptr.bas b/examples/manual/gfx/screenptr.bas
@@ -33,7 +33,7 @@ ScreenLock()
 	Dim As UByte Ptr pixel = buffer + (y * pitch) + (x * bypp)
 	
 	
-	'' Set the pixel color to 10 (light green).
+	'' Set the center pixel color to 10 (light green).
 	*pixel = 10
 
 '' Unlock the screen.
diff --git a/examples/manual/math/randomize.bas b/examples/manual/math/randomize.bas
@@ -13,3 +13,4 @@ Randomize , 1
 For i As Integer = 1 To 10
 	Print Rnd
 Next
+	
diff --git a/examples/manual/memory/callocate.bas b/examples/manual/memory/callocate.bas
@@ -21,3 +21,4 @@ Next
 
 ' Free the memory.
 Deallocate(p)
+	
diff --git a/examples/manual/memory/deallocate.bas b/examples/manual/memory/deallocate.bas
@@ -19,3 +19,4 @@ End Sub
 
    DeallocateExample1()
    End 0
+	
diff --git a/examples/manual/memory/deallocate2.bas b/examples/manual/memory/deallocate2.bas
@@ -27,3 +27,4 @@ End Sub
 
    DeallocateExample2()
    End 0
+	
diff --git a/examples/manual/memory/deallocate3.bas b/examples/manual/memory/deallocate3.bas
@@ -28,3 +28,4 @@ End Sub
 
    DeallocateExample3()
    End 0
+	
diff --git a/examples/manual/memory/reallocate.bas b/examples/manual/memory/reallocate.bas
@@ -43,3 +43,4 @@ Else '' Reallocate failed, memory unchanged
 End If
 
 Deallocate a   ' Clean up
+	
diff --git a/examples/manual/procs/thicall.bas b/examples/manual/procs/thicall.bas
@@ -0,0 +1,26 @@
+'' examples/manual/procs/thicall.bas
+''
+'' NOTICE: This file is part of the FreeBASIC Compiler package and can't
+''         be included in other distributions without authorization.
+''
+'' See Also: https://www.freebasic.net/wiki/wikka.php?wakka=KeyPgThicsall
+'' --------
+
+'' __thiscall only makes sense on windows 32-bit
+#if defined(__FB_WIN32__) And Not defined(__FB_64BIT__)
+	#define thiscall __Thiscall
+#else
+	#define thiscall
+#endif
+
+Extern "c++"
+Type UDT
+	value As Long
+	'' fbc doesn't automatically add the __thiscall calling convention
+	'' therefore, currently needs to be explicitly given where needed
+	Declare Constructor thiscall ()
+	Declare Destructor thiscall ()
+	Declare Sub someproc thiscall ()
+	'' etc
+End Type
+End Extern
diff --git a/examples/manual/proguide/procptrs/alias.bas b/examples/manual/proguide/procptrs/alias.bas
@@ -16,3 +16,4 @@ Function DoOperation (a As Integer, b As Integer, op As operation) As Integer
 End Function
 
 Print "3 + 4 = " & DoOperation(3, 4, @Add)
+		
diff --git a/examples/manual/proguide/procptrs/calling.bas b/examples/manual/proguide/procptrs/calling.bas
@@ -10,3 +10,4 @@
 #include Once "pfunc.bi"
 
 Print "3 + 4 = " & pFunc(3, 4)
+		
diff --git a/examples/manual/proguide/procptrs/dimptr.bas b/examples/manual/proguide/procptrs/dimptr.bas
@@ -8,3 +8,4 @@
 
 ' declares a pointer to sub procedure that takes no arguments
 Dim pointerToProcedure As Sub
+		
diff --git a/examples/manual/proguide/procptrs/method-ptr.bas b/examples/manual/proguide/procptrs/method-ptr.bas
@@ -34,3 +34,4 @@ p = @T.test
 Dim As T obj
 
 Print p(obj, 69) '' prints 489
+	
diff --git a/examples/manual/proguide/procptrs/passing.bas b/examples/manual/proguide/procptrs/passing.bas
@@ -14,3 +14,4 @@ Function DoOperation (a As Integer, b As Integer, operation As Function (As Inte
 End Function
 
 Print "3 + 4 = " & DoOperation(3, 4, @Add)
+		
diff --git a/examples/manual/proguide/procptrs/pfunc.bi b/examples/manual/proguide/procptrs/pfunc.bi
@@ -13,3 +13,4 @@ Function Add (a As Integer, b As Integer) As Integer
 End Function
 
 Dim pFunc As Function (As Integer, As Integer) As Integer = @Add
+		
diff --git a/examples/manual/proguide/procptrs/procptrs.bas b/examples/manual/proguide/procptrs/procptrs.bas
@@ -33,3 +33,4 @@ While (*op <> 0)
 Wend
 
 Print "Value of 'i' after all operations performed: " & i
+		
diff --git a/examples/manual/proguide/procptrs/typing-rule1.bas b/examples/manual/proguide/procptrs/typing-rule1.bas
@@ -0,0 +1,61 @@
+'' examples/manual/proguide/procptrs/typing-rule1.bas
+''
+'' NOTICE: This file is part of the FreeBASIC Compiler package and can't
+''         be included in other distributions without authorization.
+''
+'' See Also: https://www.freebasic.net/wiki/wikka.php?wakka=ProPgProcedurePointers
+'' --------
+
+'Example of assigning to a function pointer a function with:
+'   - a contravariant parameter by pointer,
+'   - and a covariant result by pointer.
+
+Type A
+	Dim As Integer I
+	Declare Constructor ()
+	Declare Destructor ()
+End Type
+Constructor A ()
+	Print "    A instance constructed", @This
+End Constructor
+Destructor A ()
+	Print "    A instance destroyed", @This
+End Destructor
+
+Type B Extends A
+	Dim As Integer J
+	Declare Constructor ()
+	Declare Constructor (ByRef a0 As A)
+	Declare Destructor ()
+End Type
+Constructor B ()
+	Print "    B instance constructed", @This
+End Constructor
+Constructor B (ByRef a0 As A)
+	Cast(A, This) = a0
+	Print "    B instance constructed", @This
+End Constructor
+Destructor B ()
+	Print "    B instance destroyed", @This
+End Destructor
+
+Function f (ByVal pa0 As A Ptr) As B Ptr
+	Return New B(*pa0)
+End Function
+
+Scope
+	Dim As Function (ByVal As B Ptr) As A Ptr pf = @f
+	Print "'Scope : Dim As B b0':"
+	Dim As B b0
+	Print
+	Print "'Dim As A Ptr pab = pf(@b0)':"
+	Dim As A Ptr pab = pf(@b0)
+	Print
+	Print "'Delete CPtr(B Ptr, pab)':"
+	Delete CPtr(B Ptr, pab)
+	Print
+	Print "'End Scope':"
+End Scope
+
+Sleep
+		
diff --git a/examples/manual/proguide/procptrs/typing-rule2.bas b/examples/manual/proguide/procptrs/typing-rule2.bas
@@ -0,0 +1,61 @@
+'' examples/manual/proguide/procptrs/typing-rule2.bas
+''
+'' NOTICE: This file is part of the FreeBASIC Compiler package and can't
+''         be included in other distributions without authorization.
+''
+'' See Also: https://www.freebasic.net/wiki/wikka.php?wakka=ProPgProcedurePointers
+'' --------
+
+'Example of assigning to a function pointer a function with:
+'   - a contravariant parameter by reference,
+'   - and a covariant result by reference.
+
+Type A Extends Object
+	Dim As Integer I
+	Declare Constructor ()
+	Declare Virtual Destructor ()
+End Type
+Constructor A ()
+	Print "    A instance constructed", @This
+End Constructor
+Destructor A ()
+	Print "    A instance destroyed", @This
+End Destructor
+
+Type B Extends A
+	Dim As Integer J
+	Declare Constructor ()
+	Declare Constructor (ByRef a0 As A)
+	Declare Virtual Destructor ()
+End Type
+Constructor B ()
+	Print "    B instance constructed", @This
+End Constructor
+Constructor B (ByRef a0 As A)
+	Cast(A, This) = a0
+	Print "    B instance constructed", @This
+End Constructor
+Destructor B ()
+	Print "    B instance destroyed", @This
+End Destructor
+
+Function f (ByRef a0 As A) ByRef As B
+	Return *New B(a0)
+End Function
+
+Scope
+	Dim As Function (ByRef As B) ByRef As A pf = @f
+	Print "'Scope : Dim As B b0':"
+	Dim As B b0
+	Print
+	Print "'Dim Byref As A rab = pf(b0)':"
+	Dim ByRef As A rab = pf(b0)
+	Print
+	Print "'Delete @rab':"
+	Delete @rab
+	Print
+	Print "'End Scope':"
+End Scope
+
+Sleep
+		
diff --git a/examples/manual/proguide/shared-lib/load.bas b/examples/manual/proguide/shared-lib/load.bas
@@ -16,8 +16,8 @@
 '' Note we specify just "mydll" as library file name; this is to ensure
 '' compatibility between Windows and Linux, where a dynamic library
 '' has different file name and extension.
-Dim As Any Ptr library = DyLibLoad( "mydll" )
-If( library = 0 ) Then
+Dim As Any Ptr libhandle = DyLibLoad( "mydll" )
+If( libhandle = 0 ) Then
 	Print "Failed to load the mydll dynamic library, aborting program..."
 	End 1
 End If
@@ -26,7 +26,7 @@ End If
 '' the address has been found. Note: It must have the same calling
 '' convention and parameters.
 Dim AddNumbers As Function( ByVal As Integer, ByVal As Integer ) As Integer
-AddNumbers = DyLibSymbol( library, "AddNumbers" )
+AddNumbers = DyLibSymbol( libhandle, "AddNumbers" )
 If( AddNumbers = 0 ) Then
 	Print "Could not retrieve the AddNumbers() function's address from the mydll library, aborting program..."
 	End 1
@@ -45,5 +45,5 @@ Print x; " +"; y; " ="; AddNumbers( x, y )
 '' Remember that once you unload a previously loaded library, all the symbols
 '' you got from it via dylibsymbol will become invalid, and accessing them
 '' will cause the application to crash.
-DyLibFree( library )
+DyLibFree( libhandle )
 	
diff --git a/examples/manual/proguide/udt/polymorphism-graph.bas b/examples/manual/proguide/udt/polymorphism-graph.bas
@@ -46,14 +46,14 @@ End Property
 
 Static Function GraphicPoint.xValid (ByVal x0 As Integer) As Integer
 	If ScreenPtr = 0 Then Return 0  '' no open graphic window
-	Dim As Integer w
+	Dim As Long w
 	ScreenInfo(w)
 	If x0 >= 0 And x0 <= w - 1 Then Return -1 Else Return 0
 End Function
 
 Static Function GraphicPoint.yValid (ByVal y0 As Integer) As Integer
 	If ScreenPtr = 0 Then Return 0  '' no open graphic window
-	Dim As Integer h
+	Dim As Long h
 	ScreenInfo( , h)
 	If y0 >= 0 And y0 <= h - 1 Then Return -1 Else Return 0
 End Function

Original file line number	Diff line number	Diff line change
`@@ -21,3 +21,4 @@ Next`
`21`	`21`
`22`	`22`	`' Free the memory.`
`23`	`23`	`Deallocate(p)`
	`24`	`+`
Original file line number	Diff line number	Diff line change
`@@ -19,3 +19,4 @@ End Sub`
`19`	`19`
`20`	`20`	`DeallocateExample1()`
`21`	`21`	`End 0`
	`22`	`+`
Original file line number	Diff line number	Diff line change
`@@ -27,3 +27,4 @@ End Sub`
`27`	`27`
`28`	`28`	`DeallocateExample2()`
`29`	`29`	`End 0`
	`30`	`+`
Original file line number	Diff line number	Diff line change
`@@ -28,3 +28,4 @@ End Sub`
`28`	`28`
`29`	`29`	`DeallocateExample3()`
`30`	`30`	`End 0`
	`31`	`+`
Original file line number	Diff line number	Diff line change
`@@ -43,3 +43,4 @@ Else '' Reallocate failed, memory unchanged`
`43`	`43`	`End If`
`44`	`44`
`45`	`45`	`Deallocate a ' Clean up`
	`46`	`+`