fbdoc: wiki snapshot 2018-09-03 & update examples from examples/manual

Author: jayrm

doc/manual/cache/CompilerErrMsg.wakka

@@ -14,7 +14,7 @@ During the program compilation three types of errors can arise:
 	- //7 Identifier's name too big, truncated//
 	- //8 Literal number too big, truncated//
 	- //9 Literal string too big, truncated//
-	- //10 UDT with pointer or var-len string fields//
+	- //10 UDT with pointer, var-len string, or var-len array fields//
 	- //11 Implicit variable allocation//
 	- //12 Missing closing quote in literal string//
 	- //13 Function result was not explicitly set//
@@ -41,7 +41,7 @@ During the program compilation three types of errors can arise:
 	- //34 '=' parsed as equality operator in function argument, not assignment to BYREF function result//
 	- //35 Mixing signed/unsigned operands//
 	- //36 Mismatching parameter initializer//
-	- //37 //
+	- //37 Ambiguous LEN or SIZEOF//
 	- //38 Suspicious logic operation, mixed boolean and non-boolean operands//
 	- //39 Redefinition of intrinsic//
 	- //40 CONST qualifier discarded//

doc/manual/cache/CompilerOptw.wakka

@@ -2,13 +2,15 @@
 Set minimum warning level.
 
 {{fbdoc item="syntax"}}##
-	**-w** //level// | **all** | **param** | **escape** | **pedantic** | **next** | **constness**
+	**-w** //level// | **all** | **none** | **param** | **escape** | **pedantic** | **next** | **funcptr** | **constness**
 ##
 {{fbdoc item="param"}}
 	##//level//##
-		Warning messages only with a level equal or greater to this value will be output.
+		Warning messages only with a level equal or greater to this value will be output.  
 	##**all**##
-		Equivalent to specifying a ##//level//## of zero (##0##).
+		Equivalent to specifying a ##//level//## of negative one (##-1##).
+	##**none**##
+		Suppresses all warnings.
 	##**param**##
 		Warn when procedure parameters aren't specified with either ##[[KeyPgByval|ByVal]]## or ##[[KeyPgByref|ByRef]]##.
 	##**escape**##
@@ -17,16 +19,20 @@ Set minimum warning level.
 		Equivalent to specifying the ##**param**## and ##**escape**## arguments, plus length checking of parameters passed ##[[KeyPgByval|ByVal]]## and of any ##[[KeyPgCptr|Cptr]]## converting to pointer only.
 	##**next**##
 		Warn when ##[[KeyPgNext|Next]]## is followed by an identifier.
+	##**funcptr**##
+		Warn on mismatched procedure pointers, including conversions in ##[[KeyPgCast|CAST]]## and ##[[KeyPgCptr|CPTR]]## expressions.  Implies '-w all'. Experimental.  Behaviour may change in future versions.
 	##**constness**##
-		Warn when ##[[KeyPgConstQualifier|CONST (Qualifier)]]## is discarded in an assignment.
+		Warn when ##[[KeyPgConstQualifier|CONST (Qualifier)]]## is discarded in an assignment. Implies '-w funcptr' and '-w all'.  Behaviour may change in future versions.
 
 {{fbdoc item="desc"}}
-	The ##-w## compiler option determines which compiler warnings, if any, are output. Each possible warning is associated with a warning level, starting from zero (##0##) and increasing with the potential problems that may occur. A significantly high ##//level//## value will have the effect of suppressing all warning messages.
+	The ##-w## compiler option determines which compiler warnings, if any, are output. Each possible warning is associated with a warning level, starting from negative one (##-1##) and increasing with the potential problems that may occur.
 
-	Note that the ##**param**##, ##**escape**##, ##**pedantic**##, ##**next**## and ##**constness**## arguments provide additional warnings not ordinarily output, even by default.
+	The ##**param**##, ##**escape**##, ##**pedantic**##, ##**next**##, ##**funcptr**##, and ##**constness**## arguments provide additional warnings not ordinarily output, even by default.
+	
+	The default, if the ##**-w**## option is not specified, is as if ##**-w 0**## was used. The ##**-w**## option can be specified multiple times.  Warning messages having a level of ##-1## are not shown by default.
+	
+	##-w none##, or a significantly high ##//level//## value will have the effect of suppressing all warning messages. 
 
-	If the ##**-w**## option is not specified, it's as if ##**-w 0**## was used. The ##**-w**## option can be specified multiple times.
-
 {{fbdoc item="see"}}
 	- [[CompilerCmdLine|Using the Command Line]]
 

doc/manual/cache/ExtLibaspell.wakka

@@ -10,52 +10,52 @@ Header version: 0.60.6.1
 {{fbdoc item="filename" value="examples/manual/libraries/aspell.bas"}}%%(freebasic)
 '' GNU-ASspell example, converted from http://aspell.net/win32/
 
-#include once "aspell.bi"
+#include Once "aspell.bi"
 
-dim as AspellConfig ptr spell_config = new_aspell_config()
+Dim As AspellConfig Ptr spell_config = new_aspell_config()
 
 '' Change this to suit the installed dictionary language if desired
 aspell_config_replace(spell_config, "lang", "en_CA")
 
 '' Create speller object
-dim as AspellCanHaveError ptr possible_err = new_aspell_speller(spell_config)
-if (aspell_error_number(possible_err) <> 0) then
-	print *aspell_error_message(possible_err)
-	end 1
-end if
-dim as AspellSpeller ptr speller = to_aspell_speller(possible_err)
-
-dim as string word
-do
-	print 
-	input "Enter a word (blank to quit): ", word
-	if (len(word) = 0) then
-		exit do
-	end if
-
-	if (aspell_speller_check(speller, strptr(word), len(word)) <> 0) then
-		print "Word is Correct"
-	else
-		print "Suggestions:"
-		dim as AspellStringEnumeration ptr elements = _
-			aspell_word_list_elements(aspell_speller_suggest(speller, strptr(word), len(word)))
-		do
-			dim as zstring ptr w = aspell_string_enumeration_next(elements)
-			if (w = 0) then
-				exit do
-			end if
-			print "   "; *w
-		loop
+Dim As AspellCanHaveError Ptr possible_err = new_aspell_speller(spell_config)
+If (aspell_error_number(possible_err) <> 0) Then
+	Print *aspell_error_message(possible_err)
+	End 1
+End If
+Dim As AspellSpeller Ptr speller = to_aspell_speller(possible_err)
+
+Dim As String word
+Do
+	Print 
+	Input "Enter a word (blank to quit): ", word
+	If (Len(word) = 0) Then
+		Exit Do
+	End If
+
+	If (aspell_speller_check(speller, StrPtr(word), Len(word)) <> 0) Then
+		Print "Word is Correct"
+	Else
+		Print "Suggestions:"
+		Dim As AspellStringEnumeration Ptr elements = _
+			aspell_word_list_elements(aspell_speller_suggest(speller, StrPtr(word), Len(word)))
+		Do
+			Dim As const ZString Ptr w = aspell_string_enumeration_next(elements)
+			If (w = 0) Then
+				Exit Do
+			End If
+			Print "   "; *w
+		Loop
 		delete_aspell_string_enumeration(elements)
-	end if
+	End If
 
 	' - Report the replacement
 	'aspell_speller_store_repl(speller, misspelled_word, size,
 	'                          correctly_spelled_word, size);
 
 	' - Add to session or personal dictionary
 	'aspell_speller_add_to_session|personal(speller, word, size)
-loop
+Loop
 
 delete_aspell_speller(speller)
 %%

doc/manual/cache/ExtLibcryptlib.wakka

@@ -9,70 +9,70 @@ Examples: in examples/math/cryptlib/
 
 {{fbdoc item="ex"}}
 {{fbdoc item="filename" value="examples/manual/libraries/cryptlib.bas"}}%%(freebasic)
-#include once "cryptlib.bi"
+#include Once "cryptlib.bi"
 
-function calc_hash( byval filename as string, byval algo as CRYPT_ALGO_TYPE ) as string
-	const BUFFER_SIZE = 8192
-	dim as byte buffer( 0 to BUFFER_SIZE-1 )
+Function calc_hash( ByVal filename As String, ByVal algo As CRYPT_ALGO_TYPE ) As String
+	Const BUFFER_SIZE = 8192
+	Dim As Byte buffer( 0 To BUFFER_SIZE-1 )
 
 	'' create a new context using the wanted algorithm
-	dim as CRYPT_CONTEXT ctx
+	Dim As CRYPT_CONTEXT ctx
 	cryptCreateContext( @ctx, CRYPT_UNUSED, algo )
 
 	'' open input file in binary mode
-	dim as integer f = freefile()
-	if( open( filename for binary access read as #f ) <> 0 ) then
-		return ""
-	end if
+	Dim As Integer f = FreeFile()
+	If( Open( filename For Binary Access Read As #f ) <> 0 ) Then
+		Return ""
+	End If
 
 	'' read until end-of-file
-	do until( eof( f ) )
-		dim as integer oldpos = seek( f )
-		get #f, , buffer()
-		dim as integer readlength = seek( f ) - oldpos
+	Do Until( EOF( f ) )
+		Dim As Integer oldpos = Seek( f )
+		Get #f, , buffer()
+		Dim As Integer readlength = Seek( f ) - oldpos
 		'' encrypt
 		cryptEncrypt( ctx, @buffer(0), readlength )
-	loop
+	Loop
 
 	'' close input file
-	close #f
+	Close #f
 
 	'' finalize
 	cryptEncrypt( ctx, 0, 0 )
 
 	'' get the hash result
-	dim as integer buffersize = BUFFER_SIZE
+	Dim As Integer buffersize = BUFFER_SIZE
 	cryptGetAttributeString( ctx, CRYPT_CTXINFO_HASHVALUE, @buffer(0), @buffersize )
 
 	'' convert to hexadecimal
-	dim as string result = ""
-	for i as integer = 0 to buffersize-1
-		result += hex( buffer(i) )
-	next
+	Dim As String result = ""
+	For i As Integer = 0 To buffersize-1
+		result += Hex( buffer(i) )
+	Next
 
 	'' free the context
 	cryptDestroyContext( ctx )
 
-	return result
-end function
+	Return result
+End Function
 
-	dim as string filename = trim( command(1) )
-	if( len( filename ) = 0 ) then
-		print "Usage: hash.exe filename"
-		end -1
-	end if
+	Dim As String filename = Trim( Command(1) )
+	If( Len( filename ) = 0 ) Then
+		Print "Usage: hash.exe filename"
+		End -1
+	End If
 
 	'' init cryptlib
 	cryptInit( )
 
 	'' calculate hashes
-	print "md5: "; calc_hash( filename, CRYPT_ALGO_MD5 )
-	print "sha: "; calc_hash( filename, CRYPT_ALGO_SHA )
+	Print "md5:  "; calc_hash( filename, CRYPT_ALGO_MD5 )
+	Print "sha1: "; calc_hash( filename, CRYPT_ALGO_SHA1 )
 
 	'' shutdown cryptlib
 	cryptEnd( )
 
-	sleep
+	Sleep
 %%
 
 {{fbdoc item="back" value="ExtLibTOC|External Library Table of Contents"}}