Download to read offline
![Ring Documentation, Release 1.4.1 Uses Dynamic Typing and Lexical scoping. No $ is required before the variable name! You can use the ‘+’ operator for string concatenation and the language is weakly typed and will convert automatically between numbers and strings based on the context. nCount = 10 # Global variable Func Main nID = 1 # Local variable See "Count = " + nCount + nl + " ID = " + nID 3.4 Trying to be natural Ring is not case-sensitive See "Enter your name ? " Give name See "Hello " + Name # Name is the same as name The list index starts from 1 aList = ["one","two","three"] See aList[1] # print one Call functions before definition one() two() three() Func one See "One" + nl Func two See "two" + nl Func three See "three" + nl The assignment operator uses Deep copy (no references in this operation) aList = ["one","two","three"] aList2 = aList aList[1] = 1 see alist[1] # print 1 see aList2[1] # print one Pass numbers and strings by value, but pass lists and objects by reference. The for in loop can update the list items. Func Main aList = [1,2,3] update(aList) see aList # print one two three Func update aList for x in aList switch x on 1 x = "one" on 2 x = "two" on 3 x = "three" off next 3.4. Trying to be natural 17](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-40-2048.jpg)
![Ring Documentation, Release 1.4.1 Using Lists during definition aList = [ [1,2,3,4,5] , aList[1] , aList[1] ] see aList # print 1 2 3 4 5 1 2 3 4 5 1 2 3 4 5 Exit from more than one loop for x = 1 to 10 for y = 1 to 10 see "x=" + x + " y=" + y + nl if x = 3 and y = 5 exit 2 # exit from 2 loops ok next next 3.5 Encourage Organization The language encourage organization, Forget bad days using languages where the programmer start with function then class then function and a strange mix between things! Each source file follow the next structure • Load Files • Statements and Global Variables • Functions • Packages and Classes This enable us to use Packages, Classes and Functions without the need to use a keyword to end these components. We can write one line comments and multi-line comments The comment starts with # or // Multi-line comments are written between /* and */ /* Program Name : My first program using Ring Date : 2015.05.08 */ See "What is your name? " # print message on screen give cName # get input from the user see "Hello " + cName # say hello! // See "Bye!" 3.6 Transparent Implementation Ring comes with transparent implementation. We can know what is happening in each compiler stage and what is going on during the run-time by the Virtual Machine Example : ring helloworld.ring -tokens -rules -ic See "Hello, World!" Output 3.5. Encourage Organization 18](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-41-2048.jpg)
![Ring Documentation, Release 1.4.1 # Our Class Class journey hello=0 it=0 is=0 me=0 func GetHello See "Hello" + nl func braceEnd See "Goodbye!" + nl We can execute code written in strings using the Eval() function cCode = "See 'Code that will be executed later!' " Eval(cCode) # execute the code to print the message We can create a list then execute code generated from that list aWords = ["hello","it","is","me"] for word in aWords cCode=word+"=0" eval(cCode) next We can read text files using the Read(cFileName) function and we can write files using the Write(cFileName,cString) function. See "Enter File Name:" Give cFileName See Read(cFileName) # Print the file content The next example presents how to create a class that defines two instructions The first instruction is : I want window The second instruction is : Window title = Expression Also keywords that can be ignored like the ‘the’ keyword New App { I want window The window title = "hello world" } Class App # Attributes for the instruction I want window i want window nIwantwindow = 0 # Attributes for the instruction Window title # Here we don't define the window attribute again title nWindowTitle = 0 # Keywords to ignore, just give them any value the=0 func geti if nIwantwindow = 0 nIwantwindow++ ok func getwant if nIwantwindow = 1 nIwantwindow++ ok func getwindow if nIwantwindow = 2 nIwantwindow= 0 see "Instruction : I want window" + nl ok 3.9. Define Natural Statements 22](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-45-2048.jpg)
![Ring Documentation, Release 1.4.1 } } The classes that power the declarative interface looks like this Class Link from ObjsBase title link Func braceend cOutput = nl+GetTabs() + "<a href='" + Link + "'> "+ Title + " </a> " + nl Class Div from ObjsBase Func braceend cOutput += nl+'<div' addattributes() AddStyle() getobjsdata() cOutput += nl+"</div>" + nl cOutput = TabMLString(cOutput) 3.11 Smart Garbage Collector Avoid memory problems :- • Invalid Memory Access • Memory leaks • Uninitialized Memory Access • Dangling pointer Rules :- • Global variables always stay in the memory, until you delete these variables using the assignment statement. • Local variables always deleted after the end of the function. • The programmer have full control on when to delete the variable from the memory using the Assignment state- ment. Example: aList = [1,2,3,4,5] aList = "nice" After the second line directly, The list [1,2,3,4,5] will be deleted from the memory and we will have a string “nice” • The programmer can call the function callgc() to force running the garbage collector. • If we have a reference to a variable (when we pass objects and lists to functions), then deleting variables will be based on reference counting, if no references everything will be deleted, but if we have a reference, the data will stay in memory. 3.11. Smart Garbage Collector 24](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-47-2048.jpg)
![Ring Documentation, Release 1.4.1 1 2 3 4 5 I will count Again! 5 4 3 2 1 To execute the natural code, We have start.ring In start.ring we define the language and the commands. File: start.ring load "stdlib.ring" load "naturallib.ring" New NaturalLanguage { SetLanguageName(:MyLanguage) SetCommandsPath(CurrentDir()+"/../command") SetPackageName("MyLanguage.Natural") UseCommand(:Hello) UseCommand(:Count) RunFile("program.txt") } We defined a language called MyLanguage, We have folder for the language commands. Each command will define a class that belong to the MyLanguage.Natural package. We will define two commands, Hello and Count. So we must have two files for defining the commands in the CurrentDir()+”/../command” folder File: hello.ring DefineNaturalCommand.SyntaxIsKeyword([ :Package = "MyLanguage.Natural", :Keyword = :hello, :Function = func { See "Hello, Sire!" + nl + nl } ]) File: count.ring 5.3. The Natural Library 31](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-54-2048.jpg)
![Ring Documentation, Release 1.4.1 DefineNaturalCommand.SyntaxIsKeywordNumberNumber([ :Package = "MyLanguage.Natural", :Keyword = :count, :Function = func { if not isattribute(self,:count_times) { AddAttribute(self,:count_times) Count_Times = 0 } if Expr(1) > Expr(2) { nStep = -1 else nStep = 1 } if Count_Times = 0 { see nl+"The Numbers!" + nl Count_Times++ else see nl + "I will count Again!" +nl } for x = Expr(1) to Expr(2) step nStep { see nl+x+nl } CommandReturn(fabs(Expr(1)-Expr(2))+1) } ]) 5.4 New Style is added to Ring Notepad In Ring Notepad - From View - Styles - Select the (Modern) Style Screen Shot: 5.4. New Style is added to Ring Notepad 32](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-55-2048.jpg)
![Ring Documentation, Release 1.4.1 6.5 Better StdLib The StdLib is updated to include the next functions • SplitMany() • JustFilePath() • JustFileName() 6.6 Better Loop|Exit Command The Loop|Exit command is updated to accept Expressions after the command (not only numbers). The syntax: Loop|Exit [Number] Changed to Loop|Exit [Expression] Example XLoop = 2 # The outer loop YLoop = 1 # The first inner loop for x = 1 to 10 for y = 1 to 10 see "x=" + x + " y=" + y + nl if x = 3 and y = 5 exit XLoop ok 6.5. Better StdLib 46](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-69-2048.jpg)
![Ring Documentation, Release 1.4.1 next next 6.7 New Functions • PackageName() function • Swap() function Example: aList = [:one,:two,:four,:three] see aList see copy("*",50) + nl swap(aList,3,4) see aList Output one two four three ************************************************** one two three four 6.8 Return Self by Reference In this release, using Return Self in class methods will return the object by reference. Example: mylist = [new mytest() { see self x = 20 see self }] see mylist class mytest x = 15 func init return self # Return by reference Output x: 15.000000 x: 20.000000 x: 20.000000 6.7. New Functions 47](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-70-2048.jpg)
![Ring Documentation, Release 1.4.1 6.9 Using ‘<’ and ‘:’ operators as ‘from’ keyword In this release of the Ring language we can use the ‘<’ and ‘:’ operators as the ‘from’ keyword Syntax (1): class Cat from Animal Syntax (2): class Cat < Animal Syntax (3): class Cat : Animal 6.10 Embedding Ring in Ring without sharing the State From Ring 1.0 we already have functions for embedding Ring in the C language. Also we can execute Ring code inside Ring programs using the eval() function. In this release we provide functions for embedding Ring in Ring programs without sharing the state. Advantages: 1. Quick integration for Ring programs and applications together without conflicts. 2. Execute and run Ring code in safe environments that we can trace. Example: pState = ring_state_init() ring_state_runcode(pState,"See 'Hello, World!'+nl") ring_state_runcode(pState,"x = 10") pState2 = ring_state_init() ring_state_runcode(pState2,"See 'Hello, World!'+nl") ring_state_runcode(pState2,"x = 20") ring_state_runcode(pState,"see x +nl") ring_state_runcode(pState2,"see x +nl") v1 = ring_state_findvar(pState,"x") v2 = ring_state_findvar(pState2,"x") see v1[3] + nl see V2[3] + nl ring_state_delete(pState) ring_state_delete(pState2) Output: Hello, World! Hello, World! 10 20 10 20 6.9. Using ‘<’ and ‘:’ operators as ‘from’ keyword 48](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-71-2048.jpg)
![Ring Documentation, Release 1.4.1 fp = fopen("ptrcmp.ring","r") fp2 = fp fp3 = fopen("ptrcmp.ring","r") see ptrcmp(fp,fp2) + nl see ptrcmp(fp,fp3) + nl fclose(fp) fclose(fp3) Output: 1 0 Also we can compare between them using the ‘=’ operator Example: fp = fopen("ptrcmp2.ring","r") fp2 = fopen("ptrcmp2.ring","r") fp3 = fp see fp = fp2 see nl see fp = fp3 fclose(fp) fclose(fp2) Output: 0 1 Example: The next function in stdlib.ring uses the PrevFileName() to know if the file of the caller function is the main source file of the program or not. Func IsMainSourceFile if PrevFileName() = sysargv[2] return true ok return false 7.3 Better Functions The find() function is updated to support searching in lists using C pointers like GUI Objects. The type() function is updated to display the C pointers types (like the GUI Object Class Name). 7.4 Better Ring Notepad The Ring Notepad will save the current line number of opened files to be restored when we switch between files. Also Ring Notepad will ask the user to save the file if the file content is changed when the user switch between files. 7.3. Better Functions 52](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-75-2048.jpg)
![Ring Documentation, Release 1.4.1 class program # Keywords Accept=0 numbers=0 then=0 print=0 the=0 sum=0 # Execution func braceexpreval x value = x func getnumbers for x=1 to value see "Enter Number ("+x+") :" give nNumber aNumbers + nNumber next func getsum nSUm = 0 for x in aNumbers nSum+= x next see "The Sum : " + nSum private value=0 aNumbers=[] Output: Enter Number (1) :3 Enter Number (2) :4 The Sum : 7 for more information see the “Natural Language Programming” chapter. 8.3 Generate/Execute Ring Object Files (*.ringo) This feature enable you to distribute your applications without distributing the source code. Also it makes application distribution a simple process where you get one Ring object file for the complete project (many source code files). Also using Ring object file remove the loading time required for compiling the application. Check the “command line options” chapter to know more about this feature. 8.4 Syntax Flexibility and different styles for I/O and Control Struc- tures Programmers are sensitive to the programming language syntax. Great programmers know how to work using many different styles but each programmer may have his/her favorite style. Each programming language comes with a style that you may like or not. Ring is just one of these languages, but as a response to many programmers asking for a better syntax we decided to provide more options. Also some of these features are very necessary for Natural Language Programming. Example : We have two commands to change language keywords and operators. ChangeRingOperator + plus ChangeRingKeyword see print Print 5 plus 5 8.3. Generate/Execute Ring Object Files (*.ringo) 58](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-81-2048.jpg)
![Ring Documentation, Release 1.4.1 • object2pointer() • pointer2object() Check the next chapters • System Functions • Object Oriented Programming (OOP) • Low Level Functions 8.6 StdLib functions and classes written in Ring Ring 1.1 comes with a library called StdLib, it’s written in Ring by the help of Ring Team The library provide a useful group of new functions and classes Example: Load "stdlib.ring" Puts("Test Times()") Times ( 3 , func { see "Hello, World!" + nl } ) Example: Load "stdlib.ring" Puts("Test Map()") See Map( 1:10, func x { return x*x } ) Example: Load "stdlib.ring" Puts("Test Filter()") See Filter( 1:10 , func x { if x <= 5 return true else return false ok } ) Example: Load "stdlib.ring" See "Testing the String Class" + nl oString = new string("Hello, World!") oString.println() oString.upper().println() oString.lower().println() oString.left(5).println() oString.right(6).println() Example: Load "stdlib.ring" oList = new list ( [1,2,3] ) oList.Add(4) oList.print() Example: 8.6. StdLib functions and classes written in Ring 61](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-84-2048.jpg)
![Ring Documentation, Release 1.4.1 Load "stdlib.ring" oStack = new Stack oStack.push(1) oStack.push(2) oStack.push(3) see oStack.pop() + nl Example: Load "stdlib.ring" oQueue = new Queue oQueue.add(1) oQueue.add(2) oQueue.add(3) see oQueue.remove() + nl Example: Load "stdlib.ring" ohashtable = new hashtable See "Test the hashtable Class Methods" + nl ohashtable { Add("Egypt","Cairo") Add("KSA","Riyadh") see self["Egypt"] + nl see self["KSA"] + nl see contains("Egypt") + nl see contains("USA") + nl see index("KSA") + NL print() delete(index("KSA")) see copy("*",60) + nl print() } Example: Load "stdlib.ring" otree = new tree See "Test the tree Class Methods" + nl otree { set("The first step") # set the root node value see value() + nl Add("one") Add("two") Add("three") { Add("3.1") Add("3.2") Add("3.3") see children } see children oTree.children[2] { Add("2.1") Add("2.2") Add("2.3") { Add("2.3.1") Add("2.3.2") Add("test") 8.6. StdLib functions and classes written in Ring 62](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-85-2048.jpg)
![Ring Documentation, Release 1.4.1 } } oTree.children[2].children[3].children[3].set("2.3.3") } see copy("*",60) + nl oTree.print() Check the next chapters: • StdLib Functions • StdLib Classes 8.7 RingLibSDL Ring 1.0 provided RingAllegro to be able to create games using the Allegro game programming library Now Ring 1.1 provide RingLibSDL also so we can have the choice between Allegro or LibSDL Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) SDL_Delay(2000) SDL_DestroyWindow(win) SDL_Quit() See the RingLibSDL Chapter. 8.8 Demo Project - Game Engine for 2D Games In practice we would create a game engine in a language like C/C++ to get the best performance then provide Ring classes to use the engine. But many 2D Games are simple and creating a game engine in Ring will be fast enough in many cases Also this would be a good demo project to learn about the language concepts where we build things using Object Ori- ented Programming (OOP) then access the power that we have using declarative programming using nested structures or using natural programming. In this project we selected the first way (declarative programming using nested structures) Example: Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" text { x = 10 y=50 animate = false size = 20 8.7. RingLibSDL 63](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-86-2048.jpg)
![Ring Documentation, Release 1.4.1 for x in aResult for t in x see t[2] + nl next next see copy("*",50) + nl for x in aResult see x["name"] + nl next sqlite_close(oSQLite) 8.10 Better Code Generator for Extensions We are using the code generator (written in Ring) every day to add new libraries to Ring. The generator is used to create RingQt and RingAllegro Also in Ring 1.1 it’s used to create RingLibSDL. more features are added like • Set/Get structure members (numbers & pointers) • Using constants • Better Generated Code See the Code Generator chapter. 8.11 Using Self.Attribute in the Class Region to define new attributes We can use Self.Attribute in the Class Region (after the class name and before any methods) to define new attributes. class Person name # Define name as attribute if it's not a global variable address phone class person2 self.name # Must Define the attribute self.address self.phone 8.12 Using This.Attribute in nested Braces inside the Class Methods We can use nested braces {} while we are inside methods to access another objects, In this case the current object scope will be changed while we are inside the brace and Self will point to the object that we access using braces {}. In this case we can use This.Attribute and This.Method() to access the object that will be created from the current class. Check the Object Oriented Programming chapter for more information. Also Check the Weight History Application in GUI Development using RingQt chapter. 8.10. Better Code Generator for Extensions 65](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-88-2048.jpg)
![Ring Documentation, Release 1.4.1 15.2 Using Geany Folder : ring/editor/geany • Run Geany editor • Click on “Tools -> configuration files -> filetypes_extensions.conf” menu • Add this line “Ring=*.ring;” without quotes after [Extensions] • In unbuntu copy file “filetypes.Ring.conf” to folder “/home/USERNAME/filetypes.Ring.conf” • You can run your files by pressing F5 button 15.2. Using Geany 88](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-111-2048.jpg)
![Ring Documentation, Release 1.4.1 15.4 Using Sublime Text 2 Folder : ring/editor/sublime text 2 In the folder Sublime_Text_2 you will find the next three files 1 - ring.json-tmlanguage 2 - ring.sublime-build 3 - ring.tmlanguage Just Copy the files to the next path "C:Users{UserName}AppDataRoamingSublime Text 2PackagesUser" The file ring.sublime-build includes the next line "cmd": ["B:ringbinring.exe","$file"], You can modify it according to the ring.exe path in your machine 15.4. Using Sublime Text 2 90](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-113-2048.jpg)
![CHAPTER SIXTEEN VARIABLES To create a new variable, you just need to determine the variable name & value. The value will determine the variable type and you can change the value to switch between the types using the same variable name. Syntax: <Variable Name> = <Value> Tip: The operator ‘=’ is used here as an Assignment operator and the same operator can be used in conditions, but for testing equality of expressions. Note: The Variable will contains the real value (not a reference). This means that once you change the variable value, the old value will be removed from memory (even if the variable contains a list or object). 16.1 Dynamic Typing Ring is a dynamic programming language that uses Dynamic Typing. x = "Hello" # x is a string see x + nl x = 5 # x is a number (int) see x + nl x = 1.2 # x is a number (double) see x + nl x = [1,2,3,4] # x is a list see x # print list items x = date() # x is a string contains date see x + nl x = time() # x is a string contains time see x + nl x = true # x is a number (logical value = 1) see x + nl x = false # x is a number (logical value = 0) see x + nl 16.2 Deep Copy We can use the assignment operator ‘=’ to copy variables. We can do that to copy values like strings & numbers. Also, we can copy complete lists & objects. The assignment operator will do a complete duplication for us. This operation called Deep Copy 93](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-116-2048.jpg)
![Ring Documentation, Release 1.4.1 list = [1,2,3,"four","five"] list2 = list list = [] See list # print the first list - no items to print See "********" + nl See list2 # print the second list - contains 5 items 16.3 Weakly Typed Ring is a weakly typed language, this means that the language can automatically convert between data types (like string & numbers) when that conversion make sense. Rules: <NUMBER> + <STRING> --> <NUMBER> <STRING> + <NUMBER> --> <STRING> Note: The same operator ‘+’ can be used as an arithmetic operator or for string concatenation. Example: x = 10 # x is a number y = "20" # y is a string sum = x + y # sum is a number (y will be converted to a number) Msg = "Sum = " + sum # Msg is a string (sum will be converted to a string) see Msg + nl 16.3. Weakly Typed 94](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-117-2048.jpg)
![Ring Documentation, Release 1.4.1 17.4 Bitwise Operators The next table presents all of the bitwise operators provided by the Ring language. Assume variable X=8 and variable Y=2 then: Operator Description Example Result & Binary AND x & y 0 | Binary OR x | y 10 ^ Binary XOR x ^ y 10 ~ Binary Ones Complement ~x -9 << Binary Left Shift x << y 32 >> Binary Right Shift x >> y 2 17.5 Assignment Operators The next table presents all of the assignment operators provided by the Ring language. Assume variable X=8 then: Operator Description Example Result = Assignment x = 10 x=10 += Add AND assignment x += 5 x=13 -= Subtract AND assignment x -= 3 x=5 *= Multiply AND assignment x *= 2 x=16 /= Divide AND assignment x /= 3 x=2.67 %= Modulus AND assignment x %= 2 x=0 <<= Left shift AND assignment x <<= 2 x=32 >>= Right shift AND assignment x >>= 2 x=2 &= Bitwise AND assignment x &= 4 x=0 |= Bitwise OR and assignment x |= 3 x=11 ^= Bitwise XOR and assignment x ^= 4 x=12 17.6 Misc Operators Operator Description :literal using : before identifier mean literal Start:End create list contains items from start to end [list items] define list items list[index] access list item obj.name using the dot operator to access object members (attributes/methods). obj {stmts} execute statements with direct access to object attributes & methods func(para,...) call function using parameters separated by comma 17.7 Operators Precedence The next table present operators from higher precedence (Evaluated first) to lower precedence. 17.4. Bitwise Operators 96](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-119-2048.jpg)
![Ring Documentation, Release 1.4.1 Operator . [] () {} - ~ :Literal [list items] ++ - - Start:End * / % + - << >> & | ^ < > <= >= = != not and or Assignment = += -= *= /= %=>>= <<= &= ^= |= Example: See 3+5*4 # prints 23 17.7. Operators Precedence 97](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-120-2048.jpg)
![Ring Documentation, Release 1.4.1 for identifier=expression to expression [step expression] Block of statements next Example: # print numbers from 1 to 10 for x = 1 to 10 see x + nl next Example: # Dynamic loop See "Start : " give nStart See "End : " give nEnd See "Step : " give nStep For x = nStart to nEnd Step nStep see x + nl Next Example: # print even numbers from 0 to 10 for x = 0 to 10 step 2 see x + nl next Example: # print even numbers from 10 to 0 for x = 10 to 0 step -2 see x + nl next • For in Loop Syntax: for identifier in List/String [step expression] Block of statements next Example: aList = 1:10 # create list contains numbers from 1 to 10 for x in aList see x + nl next # print numbers from 1 to 10 18.3 Using The Step option with For in We can use the Step option with For in to skip number of items in each iteration Example: aList = 1:10 # create list contains numbers from 1 to 10 # print odd items inside the list for x in aList step 2 see x + nl next 18.3. Using The Step option with For in 100](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-123-2048.jpg)
![Ring Documentation, Release 1.4.1 18.4 Using For in to modify lists When we use (For in) we get items by reference. This means that we can read/edit items inside the loop. Example: aList = 1:5 # create list contains numbers from 1 to 5 # replace list numbers with strings for x in aList switch x on 1 x = "one" on 2 x = "two" on 3 x = "three" on 4 x = "four" on 5 x = "five" off next see aList # print the list items 18.5 Do Again Loop Syntax: do Block of statements again expression Example: x = 1 do see x + nl x++ again x <= 10 18.6 Exit Command Used to go outside one or more of loops. Syntax: exit [expression] # inside loop Example: for x = 1 to 10 see x + nl if x = 5 exit ok next 18.4. Using For in to modify lists 101](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-124-2048.jpg)
![Ring Documentation, Release 1.4.1 18.7 Exit from two loops The next example presents how to use the exit command to exit from two loops in one jump. Example: for x = 1 to 10 for y = 1 to 10 see "x=" + x + " y=" + y + nl if x = 3 and y = 5 exit 2 # exit from 2 loops ok next next • Loop Command Used to jump to the next iteration in the loop. Syntax: loop [expression] # inside loop Example: for x = 1 to 10 if x = 3 see "Number Three" + nl loop ok see x + nl next 18.8 Exit/Loop inside sub functions While we are inside a loop, we can call a function then use the exit and/or loop command inside that function and the command will work on the outer loop. Example: # print numbers from 1 to 10 except number 5. for x = 1 to 10 ignore(x,5) see x + nl next func ignore x,y if x = y loop ok 18.9 Short-circuit evaluation The logical operators and/or follow the short-circuit evaluation. 18.7. Exit from two loops 102](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-125-2048.jpg)
![Ring Documentation, Release 1.4.1 for identifier=expression to expression [step expression] Block of statements end Example: # print numbers from 1 to 10 for x = 1 to 10 put x + nl end Example: # Dynamic loop Put "Start : " get nStart Put "End : " get nEnd Put "Step : " get nStep For x = nStart to nEnd Step nStep Put x + nl End Example: # print even numbers from 0 to 10 for x = 0 to 10 step 2 Put x + nl end Example: # print even numbers from 10 to 0 for x = 10 to 0 step -2 put x + nl end • For in Loop Syntax: for identifier in List/String [step expression] Block of statements end Example: aList = 1:10 # create list contains numbers from 1 to 10 for x in aList put x + nl end # print numbers from 1 to 10 19.3 Exceptions try Block of statements catch Block of statements end 19.3. Exceptions 107](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-130-2048.jpg)
![Ring Documentation, Release 1.4.1 (1) Say Hello (2) About (3) Exit ") nOption = GetString() switch nOption { case 1 print("Enter your name : ") name = getstring() print("Hello #{name}n") case 2 print("Sample : using switch statementn") case 3 Bye else print("bad option...n") } } • For Loop Syntax: for identifier=expression to expression [step expression] { Block of statements } Example: # print numbers from 1 to 10 load "stdlib.ring" for x = 1 to 10 { print("#{x}n") } Example: load "stdlib.ring" # Dynamic loop print("Start : ") nStart = getnumber() print("End : ") nEnd = getnumber() print("Step : ") nStep = getnumber() for x = nStart to nEnd step nStep { print("#{x}n") } Example: load "stdlib.ring" # print even numbers from 0 to 10 for x = 0 to 10 step 2 { print("#{x}n") } 20.2. Looping 110](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-133-2048.jpg)
![Ring Documentation, Release 1.4.1 Example: load "stdlib.ring" # print even numbers from 10 to 0 for x = 10 to 0 step -2 { print("#{x}n") } • For in Loop Syntax: for identifier in List/String [step expression] { Block of statements } Example: load "stdlib.ring" aList = 1:10 # create list contains numbers from 1 to 10 for x in aList { print("#{x}n") } # print numbers from 1 to 10 Example: load "stdlib.ring" aList = 1:10 # create list contains numbers from 1 to 10 # print odd items inside the list for x in aList step 2 { print("#{x}n") } When we use (For in) we get items by reference. This means that we can read/edit items inside the loop. Example: load "stdlib.ring" aList = 1:5 # create list contains numbers from 1 to 5 # replace list numbers with strings for x in aList { switch x { case 1 x = "one" case 2 x = "two" case 3 x = "three" case 4 x = "four" case 5 x = "five" } } print(aList) # print the list items 20.3 Exceptions 20.3. Exceptions 111](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-134-2048.jpg)
![CHAPTER TWENTYTWO FUNCTIONS In this chapter we are going to learn about the next topics :- • Define functions • Call functions • Declare parameters • Send parameters • Main Function • Variables Scope • Return Value • Recursion 22.1 Define Functions To define new function Syntax: func <function_name> [parameters] Block of statements Note: No keyword is required to end the function definition. Example: func hello see "Hello from function" + nl 22.2 Call Functions To call function without parameters, we type the function name then () Tip: We can call the function before the function definition and the function code. Example: 115](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-138-2048.jpg)
![Ring Documentation, Release 1.4.1 # this program will print the hello world message first then execute the main function See "Hello World!" + nl func main see "Message from the main function" + nl 22.6 Variables Scope The Ring programming language uses lexical scoping to determine the scope of a variable. Variables defined inside functions (including function parameters) are local variables. Variables defined outside func- tions (before any function) are global variables. Inside any function we can access the variables defined inside this function beside the global variables. Example: # the program will print numbers from 10 to 1 x = 10 # x is a global variable. func main for t = 1 to 10 # t is a local variable mycounter() # call function next func mycounter see x + nl # print the global variable value x-- # decrement Note: Using the main function before the for loop declare the t variable as a local variable, It’s recommended to use the main functions instead of typing the instructions directly to set the scope of the new variables to local. 22.7 Return Value The function can return a value using the Return command. Syntax: Return [Expression] Tip: the Expression after the return command is optional and we can use the return command to end the function execution without returning any value. Note: if the function doesn’t return explicit value, it will return NULL (empty string = “” ). Example: 22.6. Variables Scope 117](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-140-2048.jpg)
![CHAPTER TWENTYFOUR LISTS In this chapter we are going to learn how to deal with lists. 24.1 Create Lists We can create new lists by defining the list items inside square bracts. Example: aList = [1,2,3,4,5] Also we can create new lists using the : operator Example: aList = 1:5 aList2 = "a":"z" Example: aList = 5:1 aList2 = "z":"a" Also we can create lists using the list() function Syntax: list = list(size) Example aList = list(10) # aList contains 10 items Note: the list index start from 1 24.2 Add Items To add new items to the list, we can use the Add() function. Syntax: Add(List,Item) 120](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-143-2048.jpg)
![Ring Documentation, Release 1.4.1 Example: aList = ["one","two"] add(aList,"three") see aList Also we can do that using the + operator. Syntax: List + item Example: aList = 1:10 # create list contains numbers from 1 to 10 aList + 11 # add number 11 to the list see aList # print the list 24.3 Get List Size We can get the list size using the len() function Syntax: Len(List) Example: aList = 1:20 see len(aList) # print 20 24.4 Delete Item From List To delete an item from the list, we can use the del() function Syntax: del(list,index) Example: aList = ["one","two","other","three"] Del(aList,3) # delete item number three see aList # print one two three 24.5 Get List Item To get an item from the list, we uses the next syntax List[Index] Example: aList = ["Cairo","Riyadh"] see "Egypt : " + aList[1] + nl + "KSA : " + aList[2] + nl 24.3. Get List Size 121](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-144-2048.jpg)
![Ring Documentation, Release 1.4.1 24.6 Set List Item To set the value of an item inside the list, we can use the next syntax List[Index] = Expression Example: aList = list(3) # create list contains three items aList[1] = "one" aList[2] = "two" aList[3] = "three" see aList 24.7 Search To find an item inside the list we can use the find() function Syntax: Find(List,ItemValue) ---> Item Index Find(List,ItemValue,nColumn) ---> Search in nColumn, returns the Item Index Find(List,ItemValue,nColumn,cAttribute) ---> Item Index Example: aList = ["one","two","three","four","five"] see find(aList,"three") # print 3 Example: mylist = [["one",1], ["two",2], ["three",3]] see find(mylist,"two",1) + nl # print 2 see find(mylist,2,2) + nl # print 2 Also we can use the binarysearch() function to search in sorted list. Syntax: BinarySearch(List,ItemValue) ---> Item Index BinarySearch(List,ItemValue,nColumn) ---> Search in nColumn, returns the Item Index Example: aList = ["one","two","three","four","five"] aList = sort(aList) see binarysearch(aList,"three") Output: five four one three two 4 24.6. Set List Item 122](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-145-2048.jpg)
![Ring Documentation, Release 1.4.1 24.8 Sort We can sort the list using the sort() function. Syntax: Sort(List) ---> Sorted List Sort(List,nColumn) ---> Sorted List based on nColumn Sort(List,nColumn,cAttribute) ---> Sorted List based on Object Attribute Example: aList = [10,12,3,5,31,15] aList = sort(aList) see aList # print 3 5 10 12 15 31 We can sort list of strings Example: mylist = ["mahmoud","samir","ahmed","ibrahim","mohammed"] see mylist # print list before sorting mylist = sort(mylist) # sort list see "list after sort"+nl see mylist # print ahmed ibrahim mahmoud mohammed samir We can sort a list based on a specific column. Example: aList = [ ["mahmoud",15000] , ["ahmed", 14000 ] , ["samir", 16000 ] , ["mohammed", 12000 ] , ["ibrahim",11000 ] ] aList2 = sort(aList,1) see aList2 Output: ahmed 14000 ibrahim 11000 mahmoud 15000 mohammed 12000 samir 16000 24.9 Reverse We can reverse a list using the reverse() function. Syntax: 24.8. Sort 123](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-146-2048.jpg)
![Ring Documentation, Release 1.4.1 Reverse(List) ---> Reversed List Example: aList = [10,20,30,40,50] aList = reverse(aList) see aList # print 50 40 30 20 10 24.10 Insert Items To insert an item in the list we can use the insert() function. Syntax: Insert(List,Index,Item) The inserted item will be AFTER the Index Example: aList = ["A","B","D","E"] insert(aList,2,"C") # Inserts AFTER Index 2, "C" into Position 3 see aList # print A B C D E 24.11 Nested Lists The list may contain other lists Example: aList = [ 1 , [10,20,30] , 5 , [100,1000,5000] ] aList2 = [ "one","two", [3,4], [20,30], ["three", "four", "five",[100,200,300] ] ] see aList[2] # print 10 20 30 see aList[4][3] + nl # print 5000 see aList2[5][2] + nl # print four see aList2[5][4][3] # print 300 24.12 Copy Lists We can copy lists (including nested lists) using the Assignment operator. Example: 24.10. Insert Items 124](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-147-2048.jpg)
![Ring Documentation, Release 1.4.1 aList = [ "one","two", [3,4], [20,30], ["three", "four", "five",[100,200,300] ] ] aList2 = aList # Copy aList to aList2 aList2[5] = "other" # modify item number five see aList2[5] + nl # print other see aList[5] # print three four five 100 200 300 24.13 First-class lists Lists are first-class citizens where we can store lists in variables, pass lists to functions, and return lists from functions. Example: aList = duplicate( [1,2,3,4,5] ) see aList[10] + nl # print 5 see mylist() # print 10 20 30 40 50 func duplicate list nMax = len(list) for x = 1 to nMax list + list[x] next return list func mylist return [10,20,30,40,50] 24.14 Using Lists during definition We can use the list items while we are defining the list for the first time. Example: aList = [ [1,2,3,4,5] , aList[1] , aList[1] ] see aList # print 1 2 3 4 5 1 2 3 4 5 1 2 3 4 5 24.15 Passing Lists to Functions Lists are passed to functions by reference, This means that the called function will work on the same list and can modify it. Example: func main aList = [1,2,3,4,5] # create list, local in function main 24.13. First-class lists 125](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-148-2048.jpg)
![Ring Documentation, Release 1.4.1 myfunc(aList) # call function, pass list by reference see aList # print 1 2 3 4 5 6 7 8 9 10 func myfunc list list + [6,7,8,9,10] 24.16 Access List Items by String Index Instead of using numbers to determine the item index when we get item value or set item value, We can access items using string index if the item is a list contains two items and the first item is a string. Example: aList = [ ["one",1] , ["two",2] , ["three",3] ] see aList["one"] + nl + aList["two"] + nl + aList["three"] # print 1 2 3 This type of lists can be defined in a better syntax using the : and = operators. Example: aList = [ :one = 1 , :two = 2 , :three = 3 ] see aList["one"] + nl + aList["two"] + nl + aList["three"] + nl # print 1 2 3 see aList[1] # print one 1 Tip: using : before identifier (one word) means literal Note: using = inside list definition create a list of two items where the first item is the left side and the second item is the right side. We can add new items to the list using the string index Example: aList = [] aList["Egypt"] = "Cairo" aList["KSA"] = "Riyadh" see aList["Egypt"] + nl + # print Cairo aList["KSA"] + nl # print Riyadh 24.17 Passing Parameters Using List This type of lists is very good for passing parameters to functions Where the order of parameters will not be important (we can change the order). Also some parameters maybe optional. Example: 24.16. Access List Items by String Index 126](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-149-2048.jpg)
![Ring Documentation, Release 1.4.1 myconnect ( [ :server = "myserver.com" , :port = 80 , :username = "mahmoud" , :password = "password" ] ) func myconnect mypara # print connection details see "User Name : " + mypara[:username] + nl + "Password : " + mypara[:password] + nl + "Server : " + mypara[:server] + nl + "Port : " + mypara[:port] 24.18 Swap Items We can swap the list items using the Swap() function. Example: aList = [:one,:two,:four,:three] see aList see copy("*",50) + nl swap(aList,3,4) see aList Output one two four three ************************************************** one two three four 24.18. Swap Items 127](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-150-2048.jpg)
![Ring Documentation, Release 1.4.1 25.4 Access String Letters We can access a letter inside a string by the letter index Syntax: string[index] ---> get string letter string[index] = letter # set string letter Example: # print user name letter by letter (each letter in new line) See "Hello, Enter your name : " give cName for x = 1 to len(cName) see nl + cName[x] next We can use for in to get string letters. Example: # print user name letter by letter (each letter in new line) See "Hello, Enter your name : " give cName for x in cName see nl + x next We can modify the string letters Example: # convert the first letter to UPPER case See "Enter your name : " give cName cName[1] = upper(cName[1]) see "Hello " + cName 25.5 Left() Function We can get a specified number of characters from a string using the Left() function. The starting position is 1. Syntax: Left(string,count) Example: see left("Hello World!",5) # print Hello 25.6 Right() Function We can get a specified number of characters from a string using the Right() function. 25.4. Access String Letters 129](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-152-2048.jpg)
![Ring Documentation, Release 1.4.1 ** 09 Hour (12) ** 144 Day of the year ** 05 Month of the year ** 58 Minutes after hour ** AM AM or PM ** 38 Seconds after the hour ** 21 Week of the year (sun-sat) ** 0 day of the week ** 05/24/15 date ** 09:58:38 time ** 15 year of the century ** 2015 year ** Arab Standard Time time zone ** % percent sign */ See TimeList() Example: See "Day Name : " + TimeList()[2] # Sunday Example: See "Month Name : " + TimeList()[4] # May 26.6 AddDays() Function Syntax: AddDays(cDate,nDays) ---> Date from cDate and after nDays Example: cDate = date() see cDate + nl # 24/05/2015 cDate = adddays(cDate,10) see cDate + nl # 03/06/2015 26.7 DiffDays() Function Syntax: DiffDays(cDate1,cDate2) ---> number of days (Date1 - Date2) Example: cDate1 = date() see cDate1 + nl # 24/05/2015 cDate2 = adddays(cDate1,10) see cDate2 + nl # 03/06/2015 see "DiffDays = " + diffdays(cDate1,cDate2) + nl # -10 see "DiffDays = " + diffdays(cDate2,cDate1) + nl # 10 26.6. AddDays() Function 136](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-159-2048.jpg)
![Ring Documentation, Release 1.4.1 26.8 EpochTime() Function Syntax: EpochTime( cDate, cTime ) ---> Epoch Seconds Example: ###------------------------------------------------------------- # EpochTime() # Example --- EpochSec = EpochTime( Date(), Time() ) # Call Format: EpochSec = EpochTime( "15/07/2016", "10:15:30" ) # EpochSec = 1468577730 #--------------------------------------------------------------- Func EpochTime(Date, Time) arrayDate = split(Date, "/") arrayTime = split(Time, ":") Year = arrayDate[3] ; Month = arrayDate[2] ; Day = arrayDate[1] Hour = arrayTime[1] ; Minute = arrayTime[2] ; Second = arrayTime[3] cDate1 = Day +"/"+ Month +"/"+ Year cDate2 = "01/01/" + Year DayOfYear = DiffDays( cDate1, cDate2) ### Formula tm_sec = Second * 1 tm_min = Minute * 60 tm_hour = Hour * 3600 tm_yday = DayOfYear * 86400 tm_year = Year - 1900 tm_year1 = ( tm_year - 70) * 31536000 tm_year2 = ( floor(( tm_year - 69) / 4 )) * 86400 tm_year3 = ( floor(( tm_year - 1) / 100 )) * 86400 tm_year4 = ( floor(( tm_year + 299) / 400 )) * 86400 ### Result EpochSec = tm_sec + tm_min + tm_hour + tm_yday + tm_year1 + tm_year2 - tm_year3 + tm_year4 return EpochSec 26.8. EpochTime() Function 137](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-160-2048.jpg)
![Ring Documentation, Release 1.4.1 IsNumber(value) ---> 1 if the value is a number or 0 if not Example: see isnumber(5) + nl + # print 1 isnumber("hello") + nl # print 0 27.4 IsList() Function Using the IsList() function we can know if the value is a list or not Syntax: IsList(value) ---> 1 if the value is a list or 0 if not Example: see islist(5) + nl + # print 0 islist("hello") + nl + # print 0 islist([1,3,5]) # print 1 27.5 Type() Function We can know the type of a value using the Type() Function. Syntax: Type(value) ---> The Type as String Example: see Type(5) + nl + # print NUMBER Type("hello") + nl + # print STRING Type([1,3,5]) # print LIST 27.6 IsNULL() Function We can check the value to know if it’s null or not using the IsNULL() function Syntax: IsNULL(value) ---> 1 if the value is NULL or 0 if not Example: see isnull(5) + nl + # print 0 isnull("hello") + nl + # print 0 isnull([1,3,5]) + nl + # print 0 isnull("") + nl + # print 1 isnull("NULL") # print 1 27.4. IsList() Function 139](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-162-2048.jpg)
![CHAPTER TWENTYEIGHT MATHEMATICAL FUNCTIONS In this chapter we are going to learn about the mathematical functions 28.1 List of functions The Ring programming language comes with the next mathematical functions Function Description sin(x) Returns the sine of an angle of x radians cos(x) Returns the cosine of an angle of x radians tan(x) Returns the tangent of an angle of x radians asin(x) Returns the principal value of the arc sine of x, expressed in radians acos(x) Returns the principal value of the arc cosine of x, expressed in radians atan(x) Returns the principal value of the arc tangent of x, expressed in radians atan2(y,x) Returns the principal arc tangent of y/x, in the interval [-pi,+pi] radians sinh(x) Returns the hyperbolic sine of x radians cosh(x) Returns the hyperbolic cosine of x radians tanh(x) Returns the hyperbolic tangent of x radians exp(x) Returns the value of e raised to the xth power log(x) Returns the natural logarithm of x log10(x) Returns the common logarithm (base-10 logarithm) of x ceil(x) Returns the smallest integer value greater than or equal to x floor(x) Returns the largest integer value less than or equal to x fabs(x) Returns the absolute value of x. pow(x,y) Returns x raised to the power of y sqrt(x) Returns the square root of x random(x) Returns a random number in the range [0,x] unsigned(n,n,c) Perform operation using unsigned numbers decimals(n) Determine the decimals digits after the point in float/double numbers 28.2 Example See "Mathematical Functions" + nl See "Sin(0) = " + sin(0) + nl See "Sin(90) radians = " + sin(90) + nl See "Sin(90) degree = " + sin(90*3.14/180) + nl See "Cos(0) = " + cos(0) + nl See "Cos(90) radians = " + cos(90) + nl 146](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-169-2048.jpg)
![Ring Documentation, Release 1.4.1 cosh(1) = 1.54 tanh(0) = 0 tanh(1) = 0.76 exp(0) = 1 exp(1) = 2.72 log(1) = 0 log(2) = 0.69 log10(1) = 0 log10(2) = 0.30 log10(10) = 1 Ceil(1.12) = 2 Ceil(1.72) = 2 Floor(1.12) = 1 Floor(1.72) = 1 fabs(1.12) = 1.12 fabs(1.72) = 1.72 pow(2,3) = 8 sqrt(16) = 4 28.3 Random() Function The Random() function generate a random number and we can set the maximum value (optional). Syntax: Random(x) ---> Random number in the range [0,x] Example: for x = 1 to 20 see "Random number : " + random() + nl + "Random number Max (100) : " + random(100) + nl next Program Output: Random number : 31881 Random number Max (100) : 80 Random number : 5573 Random number Max (100) : 63 Random number : 2231 Random number Max (100) : 43 Random number : 12946 Random number Max (100) : 39 Random number : 22934 Random number Max (100) : 48 Random number : 4690 Random number Max (100) : 52 Random number : 13196 Random number Max (100) : 65 Random number : 30390 Random number Max (100) : 87 Random number : 4327 Random number Max (100) : 77 Random number : 12456 Random number Max (100) : 17 Random number : 28438 28.3. Random() Function 148](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-171-2048.jpg)
![Ring Documentation, Release 1.4.1 see "Testing DIR() " + nl mylist = dir("C:myfolder") for x in mylist if x[2] see "Directory : " + x[1] + nl else see "File : " + x[1] + nl ok next see "Files count : " + len(mylist) 29.4 Rename() Function We can rename files using the Rename() function Syntax: Rename(cOldFileName,cNewFileName) Example: rename("file.txt","help.txt") 29.5 Remove() Function We can delete a file using the Remove() function Syntax: Remove(cFileName) Example: remove("test.txt") 29.6 Fopen() Function We can open a file using the Fopen() function Syntax: Fopen(cFileName,cMode) ---> File Handle Mode Description “r” Reading (The file must exist) “w” Writing (create empty file / overwrite) “a” Appends (create file if it doesn’t exist) “r+” update (reading/writing) “w+” Create empty file (reading/writing) “a+” reading & appending 29.4. Rename() Function 153](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-176-2048.jpg)
![Ring Documentation, Release 1.4.1 30.12 Windowsnl() Function We can get the windows new line string using the Windowsnl() function. Syntax: WindowsNL() ---> Returns a string contains CR+LF = CHAR(13) + CHAR(10) Example: cStr = read("input.txt") if iswindows() cStr = substr(cStr,windowsnl(),nl) ok aList = str2list(cStr) # to do - list items processing using "for in" cStr = list2str(aList) if iswindows() cStr = substr(cStr,nl,windowsnl()) ok write("ouput.txt",cStr) 30.13 Get Command Line Arguments We can get the command line arguments passed to the ring script using the sysargv variable. The sysargv variable is a list contains the command line parameters. Example see copy("=",30) + nl see "Command Line Parameters" + nl see "Size : " + len(sysargv) + nl see sysargv see copy("=",30) + nl if len(sysargv) < 4 return ok nStart = sysargv[3] nEnd = sysargv[4] for x = nStart to nEnd see x + nl next Output b:mahmoudappsring>ring testssyspara.ring 1 10 ============================== Command Line Parameters Size : 4 ring testssyspara.ring 1 10 ============================== 30.12. Windowsnl() Function 164](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-187-2048.jpg)
![Ring Documentation, Release 1.4.1 1 2 3 4 5 6 7 8 9 10 30.14 Get Active Source File Name We can get the active source file name (*.ring) using the filename() function Syntax: filename() ---> String contains the active source file name. Example: see "Active Source File Name : " + filename() + nl Output: Active Source File Name : testsfilename.ring Example: if sysargv[2] = filename() see "I'm the main program file!" + nl # we can run tests here! else see "I'm a sub file in a program" + nl ok 30.15 PrevFileName() Function Using the PrevFileName() function we can get the previous active source file name. The previous file would be the file of the caller function, Or the file of the function that we called before calling PrevFileName(). Syntax: prevfilename() ---> String contains the previous source file name. Example: The next function in stdlib.ring uses the PrevFileName() to know if the file of the caller function is the main source file of the program or not. Func IsMainSourceFile if PrevFileName() = sysargv[2] return true ok return false 30.14. Get Active Source File Name 165](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-188-2048.jpg)
![Ring Documentation, Release 1.4.1 32.2 Main Menu Example: # Demo Program while true see " Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit " give nMenu see nl # we can use Switch-ON-Other-OFF instead of IF-BUT-ELSE-OK Switch nMenu On 1 sayhello() On 2 Sum() On 3 Stars() On 4 see "Enter Number : " give x see "Output : " Try see Fact(number(x)) Catch see "Error in parameters!" + nl Done On "5" return Other see "bad option" + nl Off end func sayhello see "Enter your name ? " give fname see "Hello " + fname + nl func sum see "number 1 : " give num1 see "number 2 : " give num2 see "Sum : " see 0 + num1 + num2 func stars for x = 1 to 10 see space(8) for y = 1 to x see "*" next see nl next func fact x if x = 1 return 1 else return x * fact(x-1) ok 32.2. Main Menu 171](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-194-2048.jpg)
![Ring Documentation, Release 1.4.1 func space x y = "" for t=1 to x y += " " next return y Output: Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 1 Enter your name ? Mahmoud Fayed Hello Mahmoud Fayed Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 2 number 1 : 3 number 2 : 4 Sum : 7 Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 3 * ** *** **** ***** ****** ******* ******** ********* ********** Main Menu =========== [1] Say Hello [2] Sum two numbers 32.2. Main Menu 172](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-195-2048.jpg)
![Ring Documentation, Release 1.4.1 [3] Stars [4] Fact [5] Exit 4 Enter Number : 5 Output : 120 Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 5 32.2. Main Menu 173](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-196-2048.jpg)
![Ring Documentation, Release 1.4.1 34.17 Restore Image From The Database Example: con = mysql_init() See "Connect to database..." + nl mysql_connect(con, "localhost", "root", "root","mahdb") See "Read data from database..." + nl mysql_query(con,"SELECT data FROM photo WHERE id=1") See "Write new file" + nl result = mysql_result(con) write("testsmahmoud2.jpg",result[1][1]) See "Close database..." + nl mysql_close(con) Output: Connect to database... Read data from database... Write new file Close database... 34.18 MySQL_AutoCommit() Function We can enable or disable the auto commit feature using the MySQL_AutoCommit() function. Syntax: MySQL_AutoCommit(MySQL Handle, lStatus) # lstatus can be True/False 34.19 MySQL_Commit() Function We can commit updates to the database using the MySQL_Commit() function. Syntax: MySQL_Commit(MySQL Handle) 34.20 MySQL_Rollback() Function We can rollback updates to the database using the MySQL_Rollback() function. Syntax: MySQL_Rollback(MySQL Handle) 34.21 Transaction Example The next example presents the usage of MySQL_Autocommit(), MySQL_Commit() & MySQL_RollBack() functions. Example: 34.17. Restore Image From The Database 190](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-213-2048.jpg)
![Ring Documentation, Release 1.4.1 35.5 Example The next code create a SQLite database, add new records then display the data. oSQLite = sqlite_init() sqlite_open(oSQLite,"mytest.db") sql = "CREATE TABLE COMPANY(" + "ID INT PRIMARY KEY NOT NULL," + "NAME TEXT NOT NULL," + "AGE INT NOT NULL," + "ADDRESS CHAR(50)," + "SALARY REAL );" sqlite_execute(oSQLite,sql) sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (1, 'Mahmoud', 29, 'Jeddah', 20000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (2, 'Ahmed', 27, 'Jeddah', 15000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (3, 'Mohammed', 31, 'Egypt', 20000.00 );" + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (4, 'Ibrahim', 24, 'Egypt ', 65000.00 );" sqlite_execute(oSQLite,sql) aResult = sqlite_execute(oSQLite,"select * from COMPANY") for x in aResult for t in x see t[2] + nl next next see copy("*",50) + nl for x in aResult see x["name"] + nl next sqlite_close(oSQLite) Output: 1 Mahmoud 29 Jeddah 20000.0 2 Ahmed 27 Jeddah 15000.0 3 Mohammed 31 Egypt 20000.0 4 35.5. Example 193](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-216-2048.jpg)
![CHAPTER THIRTYSEVEN OBJECT ORIENTED PROGRAMMING (OOP) In this chapter we are going to learn how to use the Object-Oriented programming paradigm inside the Ring program- ming language. We will learn about • Classes and Objects • Access Objects Using Braces • Composition • Setter and Getter • Private Attributes and Methods • Operator Overloading • Inheritance • Dynamic Attributes • Packages • Printing Objects • Find() and List of Objects • Sort() and List of Objects • Using Self.Attribute and Self.Method() • Using This.Attribute and This.Method() 37.1 Classes and Objects We can define new classes using the next syntax Syntax: Class <Class Name> [From|<|: <Parent Class Name>] [Attributes] [Methods] [Private [Attributes] [Methods] ] 200](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-223-2048.jpg)
![Ring Documentation, Release 1.4.1 And we can create objects using the next syntax Syntax: New <Object Name> [ (init method parameters) ] | [ { access object data and methods } ] ---> Object Example: New point { x=10 y=20 z=30 print() } Class Point x y z func print see x + nl + y + nl + z + nl Note: We can use { } to access object data and methods. Tip: we can declare the class attributes directly after the class name. Output: 10 20 30 We can rewrite the same program in another style New point # create new object using the point class { # access the new object attributes and methods x = 10 # set the x attribute to 10 y = 20 # set the y attribute to 20 z = 30 # set the z attribute to 30 print() # call the print method } # end of object access Class Point # define the Point class x y z # the class contains three attributes x, y & z func print # define the print method see x + nl + # print the x attribute y + nl + # print the y attribute z + nl # print the z attribute Also we can write the same program in another way P1 = New Point P1.x = 10 P1.y = 20 P1.z = 30 P1.Print() Class Point x y z func print see x + nl + y + nl + z + nl Note: we can use the dot operator after the object name to access object members. Also we can write the same program in another way new point { print() } Class Point x = 10 y = 20 z = 30 func print see x + nl + y + nl + z + nl 37.1. Classes and Objects 201](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-224-2048.jpg)
![Ring Documentation, Release 1.4.1 Note: we can set the default values for the class attributes when we declare them. Also we can write the same program in another way new point(10,20,30) Class Point x y z func init p1,p2,p3 x=p1 y=p2 z=p3 print() func print see x + nl + y + nl + z + nl Note: we can call the init method directly using () when we create new objects Also we can write the same program in another way new point( [ :x = 10 , :y = 20 , :z = 30 ] ) Class Point x y z func init aPara x = aPara[:x] y = aPara[:y] z = aPara[:z] print() func print see x + nl + y + nl + z + nl Tip: using Hash for passing method parameters enable us to create optional parameters and change the order of parameters when adding them to the Hash. 37.2 Access Objects Using Braces We can access the object at any time using braces { } Inside the braces we can use the object attributes and methods directly This can be done when we create the object using the New keyword or at any time using the next syntax ObjectName { access object data and methods } Example: See "Creating the Object" + nl o1 = new Point See "Using the Object" + nl o1 { x=5 y=15 z=25 print() } Class Point x y z func print see x + nl + y + nl + z We can use braces to access objects when we call functions or methods Example: o1 = new Point print( o1 { x=10 y=20 z=30 } ) func print object see object.x + nl + object.y + nl + 37.2. Access Objects Using Braces 202](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-225-2048.jpg)
![Ring Documentation, Release 1.4.1 Func operator cOperator,Para ... The function operator takes two paramters, the first represent the operator and the second represent the second param- eter after the operator. Example: o1 = new point { x = 10 y = 10 print("P1 : ") } o2 = new point { x = 20 y = 40 print("P2 : ") } o3 = o1 + o2 o3.print("P1+P2 : ") class point x y func operator cOperator,Para result = new point switch cOperator on "+" result.x = x + Para.x result.y = y + Para.y on "-" result.x = x - Para.x result.y = y - Para.y off return result func print cPoint see cPoint + "X : " + x + " Y : " + y + nl Output: P1 : X : 10 Y : 10 P2 : X : 20 Y : 40 P1+P2 : X : 30 Y : 50 37.7 Inheritance We can create class from another class in the class definition using the keyword from. Syntax: Class <Class Name> [From <Parent Class Name>] We can call a method in the parent class from the child class using the super object. Syntax: func methodname ... super.methodname() ... Example: 37.7. Inheritance 206](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-229-2048.jpg)
![Ring Documentation, Release 1.4.1 Find(List,ItemValue,nColumn,cAttribute) ---> Item Index Example: myList1 = [new Company {position=3 name="Mahmoud" symbol="MHD"}, new Company {position=2 name="Bert" symbol="BRT"}, new Company {position=1 name="Ring" symbol="RNG"} ] see find(mylist1,"Bert",1,"name") + nl see find(mylist1,"Ring",1,"name") + nl see find(mylist1,"Mahmoud",1,"name") + nl see find(mylist1,"RNG",1,"symbol") + nl see find(mylist1,"MHD",1,"symbol") + nl see find(mylist1,"BRT",1,"symbol") + nl see find(mylist1,3,1,"position") + nl see find(mylist1,1,1,"position") + nl see "Other" + nl see find(mylist1,"test",1,"name") + nl see find(mylist1,"test",0,"name") + nl see find(mylist1,"test",5,"name") + nl class company position name symbol Output: 2 3 1 3 1 2 1 3 Other 0 0 0 37.12 Sort() and list of objects We can sort a list of objects based on an object attribute using the Sort() function. Syntax: Sort(List,nColumn,cAttribute) ---> Sorted List based on Object Attribute Example: myList1 = [ new Company {position=3 name="Mahmoud" symbol="MHD"}, new Company {position=2 name="Bert" symbol="BRT"}, new Company {position=8 name="Charlie" symbol="CHR"}, new Company {position=6 name="Easy" symbol="FEAS"}, new Company {position=7 name="Fox" symbol="EFOX"}, new Company {position=5 name="Dog" symbol="GDOG"}, new Company {position=4 name="George" symbol="DGRG"}, 37.12. Sort() and list of objects 209](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-232-2048.jpg)
![Ring Documentation, Release 1.4.1 new Company {position=1 name="Ring" symbol="RNG"} ] see sort(mylist1,1,"name") see copy("*",70) + nl see sort(mylist1,1,"symbol") see copy("*",70) + nl see sort(mylist1,1,"position") class company position name symbol Output: position: 2.000000 name: Bert symbol: BRT position: 8.000000 name: Charlie symbol: CHR position: 5.000000 name: Dog symbol: GDOG position: 6.000000 name: Easy symbol: FEAS position: 7.000000 name: Fox symbol: EFOX position: 4.000000 name: George symbol: DGRG position: 3.000000 name: Mahmoud symbol: MHD position: 1.000000 name: Ring symbol: RNG ********************************************************************** position: 2.000000 name: Bert symbol: BRT position: 8.000000 name: Charlie symbol: CHR position: 4.000000 name: George symbol: DGRG position: 7.000000 name: Fox symbol: EFOX position: 6.000000 name: Easy symbol: FEAS position: 5.000000 name: Dog symbol: GDOG position: 3.000000 name: Mahmoud 37.12. Sort() and list of objects 210](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-233-2048.jpg)
![CHAPTER THIRTYEIGHT FUNCTIONAL PROGRAMMING In previous chapters we learned about Functions and Recursion. In this chapter we are going to learn about more Functional Programming (FP) concepts like • Pure Functions • First-class functions • Higher-order functions • Anonymous and nested functions. • Equality of functions 38.1 Pure Functions We can create pure functions (functions that doesn’t change the state) by the help of the assignment operator to copy variables (Lists & Objects) by value to create new variables instead of working on the original data that are passed to the function by reference. Example: Func Main aList = [1,2,3,4,5] aList2 = square(aList) see "aList" + nl see aList see "aList2" + nl see aList2 Func Square aPara a1 = aPara # copy the list for x in a1 x *= x next return a1 # return new list Output: aList 1 2 3 4 5 213](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-236-2048.jpg)
![Ring Documentation, Release 1.4.1 aList2 1 4 9 16 25 38.2 First-class Functions Functions inside the Ring programming language are first-class citizens, you can pass functions as parameters, return them as value or store them in variables. We can pass/return the function by typing the function name as literal like “FunctionName” or :FunctionName for example. We can pass/return functions using the variable that contains the function name. We can call function from variables contains the function name using the Call command Syntax: Call Variable([Parameters]) Example: Func Main see "before test2()" + nl f = Test2(:Test) see "after test2()" + nl call f() Func Test see "Message from test!" + nl Func Test2 f1 call f1() See "Message from test2!" + nl return f1 Output: before test2() Message from test! Message from test2! after test2() Message from test! 38.3 Higher-order Functions Higher-order functions are the functions that takes other functions as parameters. Example: Func Main times(5,:test) 38.2. First-class Functions 214](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-237-2048.jpg)
![Ring Documentation, Release 1.4.1 Func Test see "Message from the test function!" + nl Func Times nCount,F for x = 1 to nCount Call F() next Output: Message from the test function! Message from the test function! Message from the test function! Message from the test function! Message from the test function! 38.4 Anonymous and Nested Functions Anonymous Functions are functions without names that can be passed as parameters to other functions or stored in variables. Syntax: Func [Parameters] { [statements] } Example: test( func x,y { see "hello" + nl see "Sum : " + (x+y) + nl } ) new great { f1() } times(3, func { see "hello world" + nl } ) func test x call x(3,3) see "wow!" + nl func times n,x for t=1 to n call x() next Class great func f1 f2( func { see "Message from f1" + nl } ) func f2 x call x() Output: hello Sum : 6 38.4. Anonymous and Nested Functions 215](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-238-2048.jpg)
![Ring Documentation, Release 1.4.1 wow! Message from f1 hello world hello world hello world Example: Func Main aList = [1,2,3,4] Map (aList , func x { return x*x } ) see aList aList = [4,9,14,25] Map(aList, :myfilter ) see aList aList = [11,12,13,14] Map (aList , func x { if x%2=0 return "even" else return "odd" ok }) see aList Func myfilter x if x = 9 return "True" else return "False" ok Func Map aList,cFunc for x in aList x = call cFunc(x) next Output: 1 4 9 16 False True False False odd even odd even 38.5 Equality of functions We can test if function = function or not using the ‘=’ or ‘!=’ operators 38.5. Equality of functions 216](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-239-2048.jpg)
![Ring Documentation, Release 1.4.1 isprivateattribute(object,cAttributeName) --> Returns True if the object contains the private attribute Example: o1 = new person see isprivateattribute(o1,"name") + nl + isprivateattribute(o1,"address") + nl + isprivateattribute(o1,"phone") + nl + isprivateattribute(o1,"job") + nl + isprivateattribute(o1,"salary") Class Person name address phone private job salary Output: 0 0 0 1 1 39.22 ismethod() Function We can test if the object class contains a method or not using the ismethod() function Syntax: ismethod(object,cMethodName) --> Returns True if the object class contains the method Example: o1 = new point see ismethod(o1,"print") + nl # print 1 mylist = [] mylist + new point see ismethod(mylist[1],"print") + nl # print 1 class point x y z func print see x + nl + y + nl + z + nl 39.23 isprivatemethod() Function We can test if the object class contains a private method or not using the isprivatemethod() function Syntax: 39.22. ismethod() Function 228](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-251-2048.jpg)
![Ring Documentation, Release 1.4.1 isprivatemethod(object,cMethodName) --> Returns True if the object class contains the private method Example: o1 = new Test see isprivatemethod(o1,"f1") + nl + isprivatemethod(o1,"f2") Class Test func f1 see "message from f1()" + nl private func f2 see "message from f2()" + nl Output: 0 1 39.24 addattribute() Function We can add an attribute (or a group of attributes) to the object state (not the class) using the addattribute() function Syntax: AddAttribute(object,cAttributeName|aAttributesList) Example(1): see new point {x=10 y=20 z=30} Class Point AddAttribute(self,["x","y","z"]) Example(2): o1 = new point addattribute(o1,"x") addattribute(o1,"y") addattribute(o1,"z") see o1 {x=10 y=20 z=30} class point Output: x: 10.000000 y: 20.000000 z: 30.000000 39.25 addmethod() Function We can add a method to the object class using the addmethod() function This method can be used with any object from the same class. 39.24. addattribute() Function 229](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-252-2048.jpg)
![Ring Documentation, Release 1.4.1 o1.print() o2.print() o3.print() Class point x y z Output: 10 20 30 100 200 300 50 150 250 39.26 getattribute() function We can get the object attribute value using the getattribute() function Syntax: GetAttribute(oObject,cAttributeName) ---> Attribute Value Example: o1 = new point see getattribute(o1,"name") + nl + getattribute(o1,"x") + nl + getattribute(o1,"y") + nl + getattribute(o1,"z") + nl Class Point x=10 y=20 z=30 name = "3D-Point" Output: 3D-Point 10 20 30 Example: We can Find a Class List Member using GetAttribute() using a function findclass() The Find uses the member name, rather than the column number myList = [new Company {position=3 name="Mahmoud" symbol="MHD"}, new Company {position=2 name="Bert" symbol="BRT"}, new Company {position=1 name="Ring" symbol="RNG"} ] 39.26. getattribute() function 231](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-254-2048.jpg)
![Ring Documentation, Release 1.4.1 see myList see nl +"=====================" + nl + nl for i = 1 to len(myList) see "Pos: "+ i +" | "+ myList[i].position +" | "+ myList[i].name + " | "+ myList[i].symbol +" | "+ nl next See findclass(myList, "MHD", "symbol") +nl ### Specify Member class name ###--------------------------------------- func findclass classList, cValue, classMember See nl + "FindClass: " +" "+ cValue + nl + nl for i = 1 to len(classList) result = getattribute( classList[i], classMember ) See "Result-Attr: " + i +" "+ result +nl if result = cValue j = i ok next return j ###-------------------------------------- class company position name symbol Output: Pos: 1 | 3 | Mahmoud | MHD | Pos: 2 | 2 | Bert | BRT | Pos: 3 | 1 | Ring | RNG | FindClass: MHD Result-Attr: 1 MHD Result-Attr: 2 BRT Result-Attr: 3 RNG 1 39.27 setattribute() function We can set the object attribute value using the setattribute() function Syntax: SetAttribute(oObject,cAttributeName,Value) Example: o1 = new person setattribute(o1,"cName","Mahmoud") 39.27. setattribute() function 232](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-255-2048.jpg)
![Ring Documentation, Release 1.4.1 setattribute(o1,"nSalary",1000000) setattribute(o1,"aColors",["white","blue","yellow"]) see o1 see o1.aColors Class Person cName nSalary aColors Output: cname: Mahmoud nsalary: 1000000.000000 acolors: List... white blue yellow 39.28 mergemethods() Function We can share methods between classes without inheritance using the MergeMethods() function This function merge class methods to another class. Syntax: MergeMethods(cClassNameDestination,cClassNameSource) Example: mergemethods("count","share") mergemethods("count2","share") o1 = new count { test() } o1 = new count2 { test() } Class Share func one see "one" + nl func two see "two" + nl func three see "three" + nl Class Display Func printline see copy("*",20) + nl Class Count from Display Func test printline() one() two() three() printline() 39.28. mergemethods() Function 233](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-256-2048.jpg)
![Ring Documentation, Release 1.4.1 Load "stdlib.ring" Puts("Test Newlist()") a1 = 3 a2 = 5 chrArray = newlist(a1,a2) numArray = newlist(a1,a2) chrArray[1][1] = "Hello" numArray[1][1] = 987.2 See chrArray[1][1] + nl See numArray[1][1] + nl 40.15 capitalized() function Return a copy of a string with the first letter capitalized Syntax: Capitalized(string) ---> string Example: Load "stdlib.ring" Puts("Test Capitalized()") See capitalized("welcome to the Ring Programming Language") 40.16 isspecial() function Check whether a character is special or not Syntax: IsSpecial(char) ---> True/False Example: Load "stdlib.ring" Puts("Test Isspecial()") See "Isspecial = " + isSpecial("%") + nl 40.17 isvowel() function Check whether a character is vowel or not Syntax: IsVowel(char) ---> True/False Example: 40.15. capitalized() function 239](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-262-2048.jpg)
![Ring Documentation, Release 1.4.1 Load "stdlib.ring" Puts("Test Gcd()") see gcd (24, 32) + nl 40.28 lcm() function Compute the least common multiple of two integers. Syntax: lcm(number,number) ---> number Example: Load "stdlib.ring" Puts("Test Lcm()") see Lcm(24,36) + nl 40.29 sumlist() function Compute the sum of a list of integers. Syntax: sumlist(list) ---> number Example: Load "stdlib.ring" Puts("Test Sumlist()") aList = [1,2,3,4,5] see Sumlist(aList) + nl 40.30 prodlist() function Compute the product of a list of integers. Syntax: prodlist(list) ---> number Example: Load "stdlib.ring" Puts("Test Prodlist()") aList = [1,2,3,4,5] see Prodlist(aList) + nl 40.28. lcm() function 243](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-266-2048.jpg)
![Ring Documentation, Release 1.4.1 40.31 evenorodd() function Test whether an integer is even or odd. Result of test (1=odd 2=even). Syntax: evenorodd(number) ---> 1 (odd) or 2 (even) Example: Load "stdlib.ring" Puts("Test Evenorodd()") nr = 17 see Evenorodd(nr) + nl 40.32 factors() function Compute the factors of a positive integer. Syntax: factors(list) ---> list Example: Load "stdlib.ring" Puts("Test Factors()") n = 45 aList = factors(n) see "Factors of " + n + " = " for i = 1 to len(aList) see "" + aList[i] + " " next 40.33 palindrome() function Check if a sequence of characters is a palindrome or not. Syntax: Palindrome(String) ---> True/False Example: Load "stdlib.ring" Puts("Test Palindrome()") cString = "radar" see Palindrome(cString) 40.31. evenorodd() function 244](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-267-2048.jpg)
![Ring Documentation, Release 1.4.1 40.34 isleapyear() function Check whether a given year is a leap year in the Gregorian calendar. Syntax: Isleapyear(number) ---> True/False Example: Load "stdlib.ring" Puts("Test Isleapyear()") year = 2016 if Isleapyear(year) see "" + year + " is a leap year." else see "" + year + " is not a leap year." ok 40.35 binarydigits() function Compute the sequence of binary digits for a given non-negative integer. Syntax: binarydigits(number) ---> string Example: Load "stdlib.ring" Puts("Test Binarydigits()") b = 35 see "Binary digits of " + b + " = " + Binarydigits(b) 40.36 matrixmulti() function Multiply two matrices together. Syntax: Matrixmulti(List,List) ---> List Example: Load "stdlib.ring" # Multiply two matrices together. Puts("Test Matrixmulti()") A = [[1,2,3], [4,5,6], [7,8,9]] B = [[1,0,0], [0,1,0], [0,0,1]] see Matrixmulti(A, B) 40.37 matrixtrans() function Transpose an arbitrarily sized rectangular Matrix. 40.34. isleapyear() function 245](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-268-2048.jpg)
![Ring Documentation, Release 1.4.1 Syntax: Matrixtrans(List) ---> List Example: Load "stdlib.ring" # Transpose an arbitrarily sized rectangular Matrix. Puts("Test Matrixtrans()") matrix = [[78,19,30,12,36], [49,10,65,42,50], [30,93,24,78,10], [39,68,27,64,29]] see Matrixtrans(matrix) 40.38 dayofweek() function Return the day of the week of given date. (yyyy-mm-dd) Syntax: dayofweek(string) ---> string Example: Load "stdlib.ring" # Return the day of the week of given date. Puts("Test Dayofweek()") date = "2016-04-24" see "Data : " + date + " - Day : " + Dayofweek(date) + nl 40.39 permutation() function Generates all permutations of n different numerals. Syntax: permutation(list) Example: Load "stdlib.ring" # Generates all permutations of n different numerals Puts("Test Permutation()") list = [1, 2, 3, 4] for perm = 1 to 24 for i = 1 to len(list) see list[i] + " " next see nl Permutation(list) next 40.38. dayofweek() function 246](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-269-2048.jpg)
![Ring Documentation, Release 1.4.1 Method Description/Output Init(x) Set vValue Attribute to x value Print() Print vValue PrintLn() Print vValue then New Line Size() return number represent the size of vValue Value() return vValue Set(x) Call Init(x) 41.2 String Class Parent Class : StdBase Class Methods: Method Description/Output Init(String|Number|List) Lower() New String - Lower case characters Upper() New String - Upper case characters Left(x) New String - contains x characters from the left Right(x) New String - contains x characters from the right Lines() Number - Lines count Trim() New String - Remove Spaces Copy(x) New String - repeat string x times strcmp(cString) Compare string with cString tolist() List (String Lines to String Items) tofile(cFileName) Write string to file mid(nPos1,nPos2) New String - from nPos1 to nPos2 getfrom(nPos1) New String - from nPos1 to the end of the string replace(cStr1,cStr2,lCase) New String - Replace cStr1 with cStr2 , lCase (True=Math Case) split() List - Each Word as list item startswith(substring) Return true if the start starts with a substring endswith(substring) Return true if the start ends with a substring Example: Load "stdlib.ring" See "Testing the String Class" + nl oString = new string("Hello, World!") oString.println() oString.upper().println() oString.lower().println() oString.left(5).println() oString.right(6).println() oString = new string("Hi" + nl + "Hello" ) See oString.lines() + nl oString = new string(" Welcome ") oString.println() oString.trim().println() oString = new string("Hello! ") oString.copy(3).println() see oString.strcmp("Hello! ") + nl see oString.strcmp("Hello ") + nl see oString.strcmp("Hello!! ") + nl oString = new string(["one","two","three"]) 41.2. String Class 252](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-275-2048.jpg)
![Ring Documentation, Release 1.4.1 Ring ***Ring*** programming language ******Ring****** programming language FirstSecond FirstFirstFirst FirstFirstFirst one two three Hello How are you? 41.3 List Class Parent Class : StdBase Class Methods: Method Description/Output Init(String|List) Add(Value) Add item to the list Delete(nIndex) Delete item from the list Item(nIndex) Get item from the list First() Get the first item in the list Last() Get the last item in the list Set(nIndex,Value) Set item value FindInColumn(nCol,Value) Find item in a column Sort() Sort items - return new list Reverse() Reverse items - return new list Insert(nIndex,Value) Inset Item after nIndex example: Load "stdlib.ring" oList = new list ( [1,2,3] ) oList.Add(4) oList.print() see oList.item(1) + nl oList.delete(4) oList.print() see oList.first() + nl see oList.last() + nl oList { set(1,"one") set(2,"two") set(3,"three") print() } see oList.find("two") + nl oList.sort().print() oList.reverse().print() oList.insert(2,"nice") oList.print() oList = new list ( [ [1,"one"],[2,"two"],[3,"three"] ] ) see copy("*",10) + nl oList.print() see "Search two : " + oList.findincolumn(2,"two") + nl see "Search 1 : " + oList.findincolumn(1,1) + nl oList = new list ( [ "Egypt" , "USA" , "KSA" ] ) for x in oList 41.3. List Class 254](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-277-2048.jpg)
![Ring Documentation, Release 1.4.1 see x + nl next oList = new list ( [1,2,3,4] ) oList + [5,6,7] oList.print() oList = new list ( ["one","two"] ) oList2 = new list ( ["three","four"] ) oList + oList2 oList.print() output: 1 2 3 4 1 1 2 3 1 3 one two three 2 one three two three two one one two nice three ********** 1 one 2 two 3 three Search two : 2 Search 1 : 1 Egypt USA KSA 1 2 3 4 5 6 7 one two three 41.3. List Class 255](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-278-2048.jpg)
![Ring Documentation, Release 1.4.1 oQueue.add(2) oQueue.add(3) see oQueue.remove() + nl see oQueue.remove() + nl see oQueue.remove() + nl oQueue.add(4) see oQueue.remove() + nl oQueue { add("one") add("two") add("three") } oQueue.print() output: 1 2 3 4 one two three 41.6 HashTable Class Parent Class : List Class Methods: Method Description/Output Init(List) Add(cKey,Value) Add item to the HashTable Set(cKey,Value) Set item value using the Key GetValue(cKey) Get item value using the Key Contains(cKey) Check if the HashTable contains item using the Key Index(cKey) Get the item index using the Key example: Load "stdlib.ring" ohashtable = new hashtable See "Test the hashtable Class Methods" + nl ohashtable { Add("Egypt","Cairo") Add("KSA","Riyadh") see self["Egypt"] + nl see self["KSA"] + nl see contains("Egypt") + nl see contains("USA") + nl see index("KSA") + NL print() delete(index("KSA")) see copy("*",60) + nl print() } output: 41.6. HashTable Class 257](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-280-2048.jpg)
![Ring Documentation, Release 1.4.1 Test the hashtable Class Methods Cairo Riyadh 1 0 2 Egypt Cairo KSA Riyadh ************************************************************ Egypt Cairo 41.7 Tree Class Data: Attribute Description Data Node Value Children Children List Methods: Method Description/Output set(value) Set the node value. value() Get the node value. Add(value) Add new child. parent() Get the parent node. print() Print the tree nodes. example: Load "stdlib.ring" otree = new tree See "Test the tree Class Methods" + nl otree { set("The first step") # set the root node value see value() + nl Add("one") Add("two") Add("three") { Add("3.1") Add("3.2") Add("3.3") see children } see children oTree.children[2] { Add("2.1") Add("2.2") Add("2.3") { Add("2.3.1") Add("2.3.2") Add("test") } } oTree.children[2].children[3].children[3].set("2.3.3") } 41.7. Tree Class 258](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-281-2048.jpg)
![Ring Documentation, Release 1.4.1 Method Description sin(x) Returns the sine of an angle of x radians cos(x) Returns the cosine of an angle of x radians tan(x) Returns the tangent of an angle of x radians asin(x) Returns the principal value of the arc sine of x, expressed in radians acos(x) Returns the principal value of the arc cosine of x, expressed in radians atan(x) Returns the principal value of the arc tangent of x, expressed in radians atan2(y,x) Returns the principal arc tangent of y/x, in the interval [-pi,+pi] radians sinh(x) Returns the hyperbolic sine of x radians cosh(x) Returns the hyperbolic cosine of x radians tanh(x) Returns the hyperbolic tangent of x radians exp(x) Returns the value of e raised to the xth power log(x) Returns the natural logarithm of x log10(x) Returns the common logarithm (base-10 logarithm) of x ceil(x) Returns the smallest integer value greater than or equal to x floor(x) Returns the largest integer value less than or equal to x fabs(x) Returns the absolute value of x. pow(x,y) Returns x raised to the power of y sqrt(x) Returns the square root of x random(x) Returns a random number in the range [0,x] unsigned(n,n,c) Perform operation using unsigned numbers decimals(n) Determine the decimals digits after the point in float/double numbers example: Load "stdlib.ring" oMath = new Math See "Test the Math Class Methods" + nl See "Sin(0) = " + oMath.sin(0) + nl See "Sin(90) radians = " + oMath.sin(90) + nl See "Sin(90) degree = " + oMath.sin(90*3.14/180) + nl See "Cos(0) = " + oMath.cos(0) + nl See "Cos(90) radians = " + oMath.cos(90) + nl See "Cos(90) degree = " +oMath. cos(90*3.14/180) + nl See "Tan(0) = " + oMath.tan(0) + nl See "Tan(90) radians = " + oMath.tan(90) + nl See "Tan(90) degree = " + oMath.tan(90*3.14/180) + nl See "asin(0) = " + oMath.asin(0) + nl See "acos(0) = " + oMath.acos(0) + nl See "atan(0) = " + oMath.atan(0) + nl See "atan2(1,1) = " +oMath. atan2(1,1) + nl See "sinh(0) = " + oMath.sinh(0) + nl See "sinh(1) = " + oMath.sinh(1) + nl See "cosh(0) = " + oMath.cosh(0) + nl See "cosh(1) = " + oMath.cosh(1) + nl See "tanh(0) = " + oMath.tanh(0) + nl See "tanh(1) = " + oMath.tanh(1) + nl See "exp(0) = " + oMath.exp(0) + nl See "exp(1) = " + oMath.exp(1) + nl See "log(1) = " + oMath.log(1) + nl 41.8. Math Class 260](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-283-2048.jpg)
![Ring Documentation, Release 1.4.1 41.9 DateTime Class Methods: Method Description/Output clock() The number of clock ticks from program start. time() Get the system time. date() Get the date. timelist() List contains the date and the time information. adddays(cDate,nDays) Return Date from cDate and after nDays diffdays(cDate1,cDate2) Return the Number of days (cDate1 - cDate2) example: Load "stdlib.ring" oDateTime = new datetime See "Test the datetime Class Methods" + nl See "Calculate performance" + nl t1 = oDateTime.clock() for x = 1 to 1000000 next see oDateTime.clock() - t1 + nl See "Time : " + oDateTime.time() + nl See "Date : " + oDateTime.date() + nl See oDateTime.TimeList() See "Month Name : " + oDateTime.TimeList()[4] cDate = oDateTime.date() see cDate + nl cDate = oDateTime.adddays(cDate,10) see cDate + nl cDate1 = oDateTime.date() see cDate1 + nl cDate2 = oDateTime.adddays(cDate1,10) see cDate2 + nl see "DiffDays = " + oDateTime.diffdays(cDate1,cDate2) + nl see "DiffDays = " + oDateTime.diffdays(cDate2,cDate1) + nl output: Test the datetime Class Methods Calculate performance 85 Time : 02:53:35 Date : 31/08/2016 Wed Wednesday Aug August 08/31/16 02:53:35 31 41.9. DateTime Class 263](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-286-2048.jpg)
![Ring Documentation, Release 1.4.1 see t[2] + nl next next see copy("*",50) + nl for x in aResult see x["name"] + nl next close() } Output: Test the sqlite Class Methods 1 Mahmoud 29 Jeddah 20000.0 2 Ahmed 27 Jeddah 15000.0 3 Mohammed 31 Egypt 20000.0 4 Ibrahim 24 Egypt 65000.0 ************************************************** Mahmoud Ahmed Mohammed Ibrahim 41.18 Security Class Methods: Method Description/Output md5(cString) Calculate the MD5 hash. sha1(cString) Calculate the SHA1 hash. sha256(cString) Calculate the SHA256 hash. sha512(cString) Calculate the SHA512 hash. sha384(cString) Calculate the SHA384 hash. sha224(cString) Calculate the SHA224 hash. encrypt(cString,cKey,cIV) Cncrypts the data using the Blowfish algorithm. decrypt(cString,cKey,cIV) Decrypt the data encrypted using the Encrypt() method. randbytes(nSize) Generate a string of pseudo-random bytes. example: 41.18. Security Class 272](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-295-2048.jpg)
![CHAPTER FORTYTWO DECLARATIVE PROGRAMMING USING NESTED STRUCTURES In this chapter we are going to learn how to build declarative programming world using nested structures on the top of object oriented. We will learn about • Creating Objects inside Lists • Composition and Returning Objects and Lists by Reference • Executing code after the end of object access • Declarative Programming on the top of Object-Oriented 42.1 Creating Objects inside Lists We can create objects inside lists during list definition. Also we can add objects to the list at any time using the Add() function or the + operator. Example: alist = [new point, new point, new point] # create list contains three objects alist + [1,2,3] # add another item to the list see "Item 4 is a list contains 3 items" + nl see alist[4] add(alist , new point) alist + new point alist[5] { x = 100 y = 200 z = 300 } alist[6] { x = 50 y = 150 z = 250 } see "Object inside item 5" + nl see alist[5] see "Object inside item 6" + nl see alist[6] class point x y z Output: Item 4 is a list contains 3 items 1 2 274](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-297-2048.jpg)
![Ring Documentation, Release 1.4.1 3 Object inside item 5 x: 100.000000 y: 200.000000 z: 300.000000 Object inside item 6 x: 50.000000 y: 150.000000 z: 250.000000 42.2 Composition and Returning Objects and Lists by Reference When we use composition and have object as one of the class attributes, when we return that object it will be returned by reference. if the called used the assignment operator, another copy of the object will be created. The caller can avoid using the assignment operator and use the returned reference directly to access the object. The same is done also if the attribute is a list (not object). Note: Objects and Lists are treated using the same rules. When you pass them to function they are passed by reference, when you return them from functions they are returned by value except if it’s an object attribute where a return by reference will be done. Example: o1 = new Container myobj = o1.addobj() # the assignment will create another copy myobj.x = 100 myobj.y = 200 myobj.z = 300 see o1.aobjs[1] # print the object inside the container see myobj # print the copy Class Container aObjs = [] func addobj aobjs + new point return aobjs[len(aobjs)] # return object by reference Class point x = 10 y = 20 z = 30 Output: x: 10.000000 y: 20.000000 z: 30.000000 x: 100.000000 y: 200.000000 z: 300.000000 42.2. Composition and Returning Objects and Lists by Reference 275](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-298-2048.jpg)
![Ring Documentation, Release 1.4.1 Example(2): func main o1 = new screen { content[point()] { x = 100 y = 200 z = 300 } content[point()] { x = 50 y = 150 z = 250 } } see o1.content[1] see o1.content[2] Class Screen content = [] func point content + new point return len(content) Class point x = 10 y = 20 z = 30 Output: x: 100.000000 y: 200.000000 z: 300.000000 x: 50.000000 y: 150.000000 z: 250.000000 Example(3): func main o1 = New Screen { point() { # access the object using reference x = 100 y = 200 z = 300 } point() { # access the object using reference x = 50 y = 150 z = 250 } } see o1.content[1] see o1.content[2] Class Screen content = [] func point content + new point 42.2. Composition and Returning Objects and Lists by Reference 276](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-299-2048.jpg)
![Ring Documentation, Release 1.4.1 return content[len(content)] # return the object by reference Class point x=10 y=20 z=30 Output: x: 100.000000 y: 200.000000 z: 300.000000 x: 50.000000 y: 150.000000 z: 250.000000 42.3 Executing code after the end of object access We can access an object using { } to use object attributes and methods. if the object contains a method called BraceEnd(), it will be executed before the end of the object access. Example: New Point { See "How are you?" + nl } Class Point x y z func braceend see "I'm fine, Thank you!" + nl Output: How are you? I'm fine, Thank you! 42.4 Declarative Programming on the top of Object-Oriented The next features enable us to build and use declartive programming environment using nested structures on the top of object oriented • using {} to access the object attributes and methods • BraceEnd() Method • returning objects by reference • Setter/Getter Methods (optional) Example: # Declartive Programming (Nested Structures) Screen() { point() { x = 100 y = 200 z = 300 42.3. Executing code after the end of object access 277](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-300-2048.jpg)
![Ring Documentation, Release 1.4.1 } point() { x = 50 y = 150 z = 250 } } # Functions and Classes Func screen return new screen Class Screen content = [] func point content + new point return content[len(content)] func braceend see "I have " + len(content) + " points!" Class point x=10 y=20 z=30 func braceend see self Output: x: 100.000000 y: 200.000000 z: 300.000000 x: 50.000000 y: 150.000000 z: 250.000000 I have 2 points! 42.5 More beautiful Code We can get better results and a more beautiful code when we can avoid writing () after the method name when the methods doesn’t take parameters. This feature is not provided directly by the Ring language because there is a difference between object methods and object attributes. We can get a similar effect on the syntax of the code when we define a getter method for the object attribute. For example instead of defining the point() method. we will define the point attribute then the getpoint() method that will be executed once you try to get the value of the point attribute. since we write the variable name direcly without () we can write point instead of point() and the method getpoint() will create the object and return the object reference for us. Example: new Container { 42.5. More beautiful Code 278](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-301-2048.jpg)
![Ring Documentation, Release 1.4.1 Point { x=10 y=20 z=30 } } Class Container aObjs = [] point func getpoint aObjs + new Point return aObjs[len(aObjs)] Class Point x y z func braceend see "3D Point" + nl + x + nl + y + nl + z + nl Output 3D Point 10 20 30 42.5. More beautiful Code 279](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-302-2048.jpg)
![Ring Documentation, Release 1.4.1 aNumbers + nNumber next func getsum nSUm = 0 for x in aNumbers nSum+= x next see "The Sum : " + nSum private value=0 aNumbers=[] Output: Enter Number (1) :3 Enter Number (2) :4 The Sum : 7 43.10 BraceError() Method The next examples demonstrates how to use the “BraceError” method to handle errors when accessing the object using braces {}. Example: func main o1 = new point { x=10 y=20 z=30 TEST SEE test } class point x y z func braceerror see "Handle Error!" + nl SEE "Message :" + cCatchError + nl if ( left(cCatchError,11) = "Error (R24)" ) and not isattribute(self,"test") see "add attribute" + nl addattribute(self,"test") test = 10 ok see "done" + nl return Output: Handle Error! Message :Error (R24) : Using uninitialized variable : test add attribute done 10 Example: new point { x=10 y=20 z=30 test() see "mmm..." + NL } 43.10. BraceError() Method 287](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-310-2048.jpg)
![Ring Documentation, Release 1.4.1 Each command will define a class that belong to the MyLanguage.Natural package. We will define two commands, Hello and Count. So we must have two files for defining the commands in the CurrentDir()+”/../command” folder File: hello.ring DefineNaturalCommand.SyntaxIsKeyword([ :Package = "MyLanguage.Natural", :Keyword = :hello, :Function = func { See "Hello, Sire!" + nl + nl } ]) File: count.ring DefineNaturalCommand.SyntaxIsKeywordNumberNumber([ :Package = "MyLanguage.Natural", :Keyword = :count, :Function = func { if not isattribute(self,:count_times) { AddAttribute(self,:count_times) Count_Times = 0 } if Expr(1) > Expr(2) { nStep = -1 else nStep = 1 } if Count_Times = 0 { see nl+"The Numbers!" + nl Count_Times++ else see nl + "I will count Again!" +nl } for x = Expr(1) to Expr(2) step nStep { see nl+x+nl } CommandReturn(fabs(Expr(1)-Expr(2))+1) } ]) 44.2 Defining Commands To define new command we can use the DefineNaturalCommand object This object provides the next methods :- • SyntaxIsKeyword(aPara) • SyntaxIsKeywordNumber(aPara) • SyntaxIsKeywordNumberNumber(aPara) • SyntaxIsKeywordNumbers(aPara,nCount) • SyntaxIsKeywordString(aPara) • SyntaxIsKeywordStringString(aPara) 44.2. Defining Commands 292](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-315-2048.jpg)
![Ring Documentation, Release 1.4.1 • SyntaxIsKeywordStrings(aPara,nCount) • SyntaxIsKeywordExpression(aPara) • SyntaxIsKeywordExpressionExpression(aPara) • SyntaxIsKeywordExpressions(aPara,nCount) • SyntaxIsCommand(aPara) • SyntaxIsCommandNumber(aPara) • SyntaxIsCommandNumberNumber(aPara) • SyntaxIsCommandNumbers(aPara,nCount) • SyntaxIsCommandString(aPara) • SyntaxIsCommandStringString(aPara) • SyntaxIsCommandStrings(aPara,nCount) • SyntaxIsCommandExpression(aPara) • SyntaxIsCommandExpressionExpression(aPara) • SyntaxIsCommandExpressions(aPara,nCount) File: mylanguage.ring load "stdlib.ring" load "naturallib.ring" MyLanguage = New NaturalLanguage { SetLanguageName(:MyLanguage) setCommandsPath(CurrentDir()+"/../command") SetPackageName("MyLanguage.Natural") UseCommand(:Hello) UseCommand(:Count) UseCommand(:Print) UseCommand(:IWantWindow) UseCommand(:WindowTitleIs) UseCommand(:IWantButton) } Example (1) In the next example we will define the Print command. We will use the SyntaxIsKeywordExpression() Method. We pass list (as Hash) to the method. We determine the package name, the keyword and the function that will be executed. Inside this function we uses the Expr(nExprNumber) function to get the expression value that the user will write after the keyword. File: print.ring DefineNaturalCommand.SyntaxIsKeywordExpression([ :Package = "MyLanguage.Natural", :Keyword = :print, :Function = func { See Expr(1) } ]) 44.2. Defining Commands 293](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-316-2048.jpg)
![Ring Documentation, Release 1.4.1 Usage: load "mylanguage.ring" MyLanguage.RunString(' print "Hello, World!" ') Output: Hello, World! Example (2) File: iwantwindow.ring DefineNaturalCommand.SyntaxIsCommand([ :Package = "MyLanguage.Natural", :Command = "i want window", :Function = func { See "Command: I want window" + nl } ]) Usage: load "mylanguage.ring" MyLanguage.RunString(' i want window ') Output: Command: I want window Example (3) File: windowtitleis.ring DefineNaturalCommand.SyntaxIsCommandString([ :Package = "MyLanguage.Natural", :Command = "window title is", :Function = func { See "Command: Window title is " + Expr(1) + nl } ]) Usage: load "mylanguage.ring" MyLanguage.RunString(' I want window and the window title is "Hello World" ') Output: Command: I want window Command: Window title is Hello World 44.2. Defining Commands 294](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-317-2048.jpg)
![Ring Documentation, Release 1.4.1 Package MyLanguage.Natural class Count func Getcount StartCommand() CommandData()[:name] = :Count CommandData()[:nExpr] = 0 CommandData()[:aExpr] = [] func BraceExprEval_Count nValue if isCommand() and CommandData()[:name] = :Count { if isNumber(nValue) { CommandData()[:nExpr]++ CommandData()[:aExpr] + nValue if CommandData()[:nExpr] = 2 { Count_Execute() } } } func AddAttributes_Count AddAttribute(self,:count) func Count_Execute if not isattribute(self,:count_times) { AddAttribute(self,:count_times) Count_Times = 0 } if Expr(1) > Expr(2) { nStep = -1 else nStep = 1 } if Count_Times = 0 { see nl+"The Numbers!" + nl Count_Times++ else see nl + "I will count Again!" +nl } for x = Expr(1) to Expr(2) step nStep { see nl+x+nl } CommandReturn(fabs(Expr(1)-Expr(2))+1) 44.4. Defining commands using classes 296](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-319-2048.jpg)
![Ring Documentation, Release 1.4.1 Tip: the difference between ex. 1 and ex. 2 is using WebPage() function to return the page object instead of creating the object using new statement. 45.4 Web Library Features The next features are provided by the Web library to quickly create web applications. • Generate HTML pages using functions • Generate HTML pages using objects • HTTP Get • HTTP Post • Files Upload • URL Encode • Templates • CRUD MVC Sample • Users Logic & Registration Sample 45.5 HTTP Get Example The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { Title = "Test HTTP Get" divstart([ :style = StyleSizeFull() ] ) boxstart() text( "Test HTTP GET" ) newline() boxend() divstart([ :style = Styledivcenter("600px","550px") + StyleGradient(21) ]) divstart([:style = stylefloatleft() + stylesize("100px","100%") + stylecolor("black") + stylegradient(58)]) formstart("ex5.ring") tablestart([ :style = stylesize("65%","90%") + stylemarginleft("35%") + stylemargintop("30%") ]) rowstart([]) cellstart([]) text ( "Name : " ) cellend() cellstart([]) cTextboxStyle = StyleMarginLeft("5%") + StyleWidth("250px") + StyleColor("black") + 45.4. Web Library Features 299](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-322-2048.jpg)
![Ring Documentation, Release 1.4.1 StyleBackColor("white") textbox([ :name = "Name", :style = cTextboxStyle ] ) cellend() rowend() rowstart([]) cellstart([]) text ( "Address : " ) cellend() cellstart([]) textbox([ :name = "Address", :style = cTextboxStyle] ) cellend() rowend() rowstart([]) cellstart([]) text ( "Phone : " ) cellend() cellstart([]) textbox([ :name = "Phone", :style = cTextboxStyle ]) cellend() rowend() rowstart([]) cellstart([]) text ( "Age : " ) cellend() cellstart([]) textbox([ :name = "Age", :style = cTextboxStyle ]) cellend() rowend() rowstart([]) cellstart([]) text ( "City: " ) cellend() cellstart([]) listbox([ :name = "City", :items = ["Cairo","Riyadh","Jeddah"], :style = stylemarginleft("5%") + stylewidth("400px") ] ) cellend() rowend() rowstart([]) cellstart([]) text ( "Country : " ) cellend() cellstart([]) combobox([ :name = "Country", :items = ["Egypt","Saudi Arabia","USA"], :style = stylemarginleft("5%") + stylewidth("400px")+ stylecolor("black")+ stylebackcolor("white")+ stylefontsize("14px") ]) cellend() rowend() rowstart([]) cellstart([]) text ( "Note : " ) cellend() cellstart([]) editbox([ :name = "Notes", :style = stylemarginleft("5%") + 45.5. HTTP Get Example 300](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-323-2048.jpg)
![Ring Documentation, Release 1.4.1 stylesize("400px","100px")+ stylecolor("black")+ stylebackcolor("white") , :value = "write comments here..." ] ) cellend() rowend() rowstart([]) cellstart([]) cellend() cellstart([]) submit([ :value = "Send" , :Style = stylemarginleft("5%") ]) cellend() rowend() tableend() formend() divend() divend() divend() } Screen Shot: 45.5. HTTP Get Example 301](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-324-2048.jpg)
![Ring Documentation, Release 1.4.1 The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { divstart([ :style = styledivcenter("800px","500px") ]) boxstart() text ( "HTTP GET Response" ) newline() boxend() divstart([ :style = stylefloatleft()+stylewidth("10%")+ 45.5. HTTP Get Example 302](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-325-2048.jpg)
![Ring Documentation, Release 1.4.1 stylecolor("black")+stylegradient(58) ]) newline() text ( "Name : " ) newline() newline() text ( "Address : " ) newline() newline() text ( "Phone : " ) newline() newline() text ( "Age : " ) newline() newline() text ( "City : " ) newline() newline() text ( "Country : " ) newline() newline() text ( "Note : " ) newline() newline() divend() divstart([ :style = stylefloatleft()+stylewidth("90%")+ stylecolor("black")+stylegradient(47) ]) divstart([ :style = stylefloatleft() + stylewidth("1%") ]) newline() divend() divstart([ :style = stylefloatleft() + stylewidth("95%") ]) newline() text ( aPageVars["Name"] ) newline() newline() text ( aPageVars["Address"] ) newline() newline() text ( aPageVars["Phone"] ) newline() newline() text ( aPageVars["Age"] ) newline() newline() text ( aPageVars["City"] ) newline() newline() text (aPageVars["Country"] ) newline() newline() text ( aPageVars["Notes"] ) newline() newline() divend() divend() divend() } Screen Shot: 45.5. HTTP Get Example 303](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-326-2048.jpg)
![Ring Documentation, Release 1.4.1 45.6 HTTP POST Example The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Post Test") newline() boxend() divstart([ :style=StyleFloatLeft()+StyleWidth("100px") ]) newline() text( "Number1 : " ) newline() newline() text( "Number2 : " ) newline() newline() divend() formpost("ex7.ring") divstart([ :style = styleFloatLeft()+StyleWidth("200px") ]) newline() textbox([ :name = "Number1" ]) newline() newline() textbox([ :name = "Number2" ]) newline() newline() submit([ :value = "Send" ] ) divend() formend() } Screen Shot: 45.6. HTTP POST Example 304](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-327-2048.jpg)
![Ring Documentation, Release 1.4.1 The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Post Result" ) newline() boxend() divstart([ :style = styleFloatLeft()+styleWidth("200px") ]) newline() text( "Number1 : " + aPageVars["Number1"] ) newline() newline() text( "Number2 : " + aPageVars["Number2"] ) newline() newline() text( "Sum : " + (0 + aPageVars["Number1"] + aPageVars["Number2"] ) ) newline() divend() } Screen Shot: 45.6. HTTP POST Example 305](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-328-2048.jpg)
![Ring Documentation, Release 1.4.1 45.7 Upload Files The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New page { boxstart() text( "Upload File" ) newline() boxend() for x = 1 to 3 newline() next formupload("ex9.ring") text( "Customer Name : " ) textbox([ :name = "custname" ]) newline() newline() divstart([ :style = styleFloatLeft() + styleWidth("90px") ]) uploadfile("file") newline() newline() uploadfile("file2") newline() newline() submit([ :value = "Send" ]) divend() formend() } Screen Shot: 45.7. Upload Files 306](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-329-2048.jpg)
![Ring Documentation, Release 1.4.1 The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web cUploadPath = "C:/Apache2.2/htdocs/ringapp/upload/" cUploadFolder = "/ringapp/upload/" New page { boxstart() text( "Upload Result" ) newline() boxend() newline() divstart([ :style= styleFloatLeft() + styleWidth("100px") ]) text( "Name : " + aPageVars["custname"] ) newline() divend() if aPageVars["file"] != char(13) getuploadedfile(self,"file") ok if aPageVars["file2"] != char(13) getuploadedfile(self,"file2") ok } Func getuploadedfile oObj,cFile # here we use object.property # instead of object { } to avoid executing braceend method cFileName = cUploadPath + oObj.getfilename(aPageVars,cFile) 45.7. Upload Files 307](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-330-2048.jpg)
![Ring Documentation, Release 1.4.1 write(cFileName,aPageVars[cFile]) system("chmod a+x "+cFileName) oObj.newline() oObj.text( "File "+cFileName+ " Uploaded ..." ) oObj.newline() imageURL = cUploadFolder+oObj.getfilename(aPageVars,cFile) oObj.link([ :url = imageURL, :title = "Download" ]) oObj.newline() oObj.image( [ :url = imageURL , :alt = :image ] ) oObj.newline() Screen Shot: 45.7. Upload Files 308](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-331-2048.jpg)
![Ring Documentation, Release 1.4.1 Import System.Web New page { boxstart() text( "Cookie Test" ) newline() boxend() newline() link([ :url = "ex11.ring", :title = "Use Cookies" ]) cookie("custname","Mahmoud Fayed") cookie("custage",28) } Screen Shot: The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Cookies Values" ) newline() boxend() link([ :url = "ex10.ring", :title = "back" ]) newline() divstart([:style="float:left;width:200px"]) text( "Name : " + aPageVars["custname"] ) newline() text( "Age : " + aPageVars["custage"] ) newline() divend() } Screen Shot: 45.8. Cookies 310](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-333-2048.jpg)
![Ring Documentation, Release 1.4.1 45.9 URL Encode The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "URLEncode" ) newline() boxend() link([ :url = "ex5.ring?Name="+URLEncode("-*{Mahmoud}*-")+ "&Address=Egypt&Phone=123456&Age=28&Notes=Programmer", :title = "Test URL Encode" ]) } Screen Shot: Screen Shot: 45.9. URL Encode 311](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-334-2048.jpg)
![Ring Documentation, Release 1.4.1 Class NumbersController MyHeader aNumbers Func Start MyHeader = New Header { cColumn1 = "Number" cColumn2 = "Square" } aNumbers = list(20) for x = 1 to len(aNumbers) aNumbers[x] = new number { nValue = x nSquare = x*x } next cTemp = Template("mynumbers.html",self) New Page { boxstart() text( "Test Templates" ) newline() boxend() html(cTemp) } Class Header cColumn1 cColumn2 Class Number nValue nSquare Screen Shot: 45.10. Templates 313](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-336-2048.jpg)
![Ring Documentation, Release 1.4.1 #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text("HTML Special Characters") newline() boxend() text(' <html> <body> <p> "hello world" </p> </body> </html> ') } Screen Shot: 45.12 Hash Functions The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Hash Test") newline() boxend() divstart([ :style = StyleFloatLeft() + StyleWidth("100px") ]) newline() text( "Value : " ) newline() newline() divend() formpost("ex16.ring") divstart([ :style = StyleFloatLeft() + StyleWidth("300px") ]) newline() 45.12. Hash Functions 315](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-338-2048.jpg)
![Ring Documentation, Release 1.4.1 textbox([ :name = "Value" ]) newline() newline() submit([ :value = "Send" ]) divend() formend() } Screen Shot: The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Hash Result" ) newline() boxend() divstart([ :style = styleFloatLeft() + styleWidth("100%") ]) newline() text( "Value : " + aPageVars["Value"] ) newline() text( "MD5 : " + MD5(aPageVars["Value"]) ) newline() text( "SHA1 : " + SHA1(aPageVars["Value"]) ) newline() text( "SHA256 : " + SHA256(aPageVars["Value"]) ) newline() text( "SHA224 : " + SHA224(aPageVars["Value"]) ) newline() text( "SHA384 : " + SHA384(aPageVars["Value"]) ) newline() text( "SHA512 : " + SHA512(aPageVars["Value"]) ) newline() divend() } Screen Shot: 45.12. Hash Functions 316](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-339-2048.jpg)
![Ring Documentation, Release 1.4.1 45.13 Random Image #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web cUploadPath = "C:/Apache2.2/htdocs/ringapp/upload/" New Page { boxstart() text( "Random Test") newline() boxend() divstart([ :style = styleFloatLeft() + styleWidth("400px") ]) newline() aList = dir(cUploadPath) if len(aList) > 0 nIndex = random(len(aList)) if nindex = 0 nIndex = 1 ok cItem = "upload/" + aList[nIndex][1] newline() image( [ :url = cItem , :alt = :image ] ) else text("No images!") newline() ok divend() } Screen Shot: 45.13. Random Image 317](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-340-2048.jpg)
![Ring Documentation, Release 1.4.1 45.14 HTML Lists The next example print a list contains numbers from 1 to 10 Then print a list from Ring List. Finally we have a list of buttons and when we press on a button we get a message contains the clicked button number. To start the list we uses the ulstart() function. To end the list we uses the ulend() function. We uses listart() and liend() to determine the list item. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main New Page { ulstart([]) for x = 1 to 10 listart([]) text(x) liend() next ulend() list2ul(["one","two","three","four","five"]) ulstart([]) for x = 1 to 10 listart([]) 45.14. HTML Lists 318](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-341-2048.jpg)
![Ring Documentation, Release 1.4.1 cFuncName = "btn"+x+"()" button([ :onclick = cFuncName , :value = x]) script(scriptfuncalert(cFuncName,string(x))) liend() next ulend() } Screen Shot: 45.14. HTML Lists 319](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-342-2048.jpg)
![Ring Documentation, Release 1.4.1 45.15 HTML Tables In this example we will learn how to generate HTML tables using the tablestart(), tableend(), rowstart(), rowend() ,headerstart(), headerend(), cellstart() and cellend() functions. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main New Page { divstart([ :style = styledivcenter("400px","500px") ] ) style(styletable() + styletablerows("t01")) tablestart([ :id = :t01 , :style = stylewidth("100%") ]) rowstart([]) headerstart([]) text("Number") headerend() headerstart([]) text("square") headerend() rowend() for x = 1 to 10 rowstart([]) cellstart([]) text(x) cellend() cellstart([]) text(x*x) cellend() rowend() next tableend() divend() } Screen Shot: 45.15. HTML Tables 320](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-343-2048.jpg)
![Ring Documentation, Release 1.4.1 45.16 Gradient In this example we will learn how to use the StyleGradient() function. The function takes the style number as input (range from 1 to 60). #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main New Page { boxstart() text("StyleGradient() Function") boxend() for x = 1 to 60 divstart([ :id = x , :align = "center" , :style = stylefloatleft() + stylesize(string(100/60*6)+"%","50px") + stylegradient(x) ]) h3(x) divend() next } Screen Shot: 45.16. Gradient 321](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-344-2048.jpg)
![Ring Documentation, Release 1.4.1 45.18 Using Bootstrap Library using Functions The next example uses the Bootstrap JavaScript Library when generating the HTML page. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main new BootstrapPage { divstart([ :class = "container" ]) divstart([ :class = "jumbotron" ]) h1("Bootstrap Page") divend() 45.18. Using Bootstrap Library using Functions 326](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-349-2048.jpg)
![Ring Documentation, Release 1.4.1 divstart([ :class = :row ]) divstart([ :class = "col-sm-4" ]) h3("Welcome to the Ring programming language") p([ :text = "Using a scripting language is very fun!" ]) divend() divstart([ :class = "col-sm-4" ]) h3("Welcome to the Ring programming language") p([ :text = "using a scripting language is very fun!" ]) divend() divstart([ :class = "col-sm-4" ]) h3("Welcome to the Ring programming language") p([ :text = "using a scripting language is very fun!" ]) divend() divend() divend() } Screen Shot: 45.19 Using Bootstrap Library using Objects The next example uses the Bootstrap JavaScript Library when generating the HTML page. Instead of using functions to generate the HTML elements, we will use objects. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main 45.19. Using Bootstrap Library using Objects 327](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-350-2048.jpg)
![Ring Documentation, Release 1.4.1 Class SalaryModel from ModelBase Class SalaryController From ControllerBase Class SalaryView From ViewBase oLanguage = new SalaryLanguageEnglish Func AddFuncScript oPage,oController return oPage.scriptfuncajax("myadd",oController.cMainURL+ oController.cOperation+"=add","mysubpage") Func FormViewContent oController,oTranslation,oPage return [ [ oTranslation.aColumnsTitles[2], "textbox", "name", oController.oModel.Name, oPage.stylewidth("100%") ], [ oTranslation.aColumnsTitles[3], "textbox", "salary", oController.oModel.Salary, oPage.stylewidth("50%") ] ] Class SalaryLanguageEnglish cTitle = "Salary Table" cBack = "back" aColumnsTitles = ["ID","Name","Salary"] cOptions = "Options" cSearch = "Search" comboitems = ["Select Option...","Edit","Delete"] cAddRecord = "Add Record" cEditRecord = "Edit Record" cRecordDeleted = "Record Deleted!" aMovePages = ["First","Prev","Next","Last"] cPage = "Page" cOf = "of" cRecordsCount = "Records Count" cSave = "Save" temp = new page cTextAlign = temp.StyleTextRight() cNoRecords = "No records!" Screen Shot: 45.20. CRUD Example using MVC 331](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-354-2048.jpg)
![Ring Documentation, Release 1.4.1 aColumnsNames = ["id","username","email"] Func UpdateRecord oModel.id = aPageVars[cRecID] oModel.updatecolumn("username", aPageVars[:username] ) oModel.updatecolumn("email", aPageVars[:email] ) oView.UpdateView(self) Class UsersView from ViewBase oLanguage = new UsersLanguageEnglish Func AddFuncScript oPage,oController return oPage.scriptfunc("myadd",oPage.scriptredirection("ex26.ring")) Func FormViewContent oController,oTranslation,oPage return [ [oTranslation.aColumnsTitles[2],"textbox","username", oController.oModel.UserName,oPage.stylewidth("100%")], [oTranslation.aColumnsTitles[3],"textbox","email", oController.oModel.Email,oPage.stylewidth("50%")] ] Class UsersLanguageEnglish cTitle = "Users Table" cBack = "back" aColumnsTitles = ["ID","User Name","Email"] cOptions = "Options" cSearch = "Search" comboitems = ["Select Option...","Edit","Delete"] cAddRecord = "Add Record" cEditRecord = "Edit Record" cRecordDeleted = "Record Deleted!" aMovePages = ["First","Prev","Next","Last"] cPage = "Page" cOf = "of" cRecordsCount = "Records Count" cSave = "Save" temp = new page cTextAlign = temp.StyleTextRight() cNoRecords = "No records!" In the file ex25.ring we load ex25_users.ring then create an object from UsersController class. Using the created object, we call the routing method. #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" Import System.Web website = "ex25.ring" New UsersController { Routing() } Screen Shot: 45.21. Users registration and Login 333](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-356-2048.jpg)
![Ring Documentation, Release 1.4.1 See the next code for the registration page #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Import System.Web website = "ex26.ring" new page { boxstart() text( "Register") newline() boxend() divstart([:style = stylegradient(6) + stylesize("100%","95%") ]) link([ :url = website, :title = "back" , :style = stylecolor("white")]) newline() divstart([ :style= styledivcenter("500","160") + stylegradient(52) ]) formpost("ex27.ring") tablestart([ :Style = stylemarginleft("2%") + stylemargintop("2%") + stylewidth("90%") ]) rowstart([]) cellstart([:style = stylewidth("20%") + styleheight(30)]) text("User Name") cellend() cellstart([ :style = stylewidth("80%") ]) textbox([:name = "username", :style = stylewidth("100%")]) cellend() rowend() rowstart([]) cellstart([ :Style = styleheight(30)]) text("Password") cellend() cellstart([]) textbox([:name = "password" , :type = "password"]) 45.21. Users registration and Login 334](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-357-2048.jpg)
![Ring Documentation, Release 1.4.1 cellend() rowend() rowstart([]) cellstart([ :style = styleheight(30)]) text("Email") cellend() cellstart([]) textbox([:name = "email" , :style = stylewidth("100%")]) cellend() rowend() rowstart([]) cellstart([ :style = styleheight(30)]) cellend() cellstart([ :style = styleheight(30)]) submit([:value = "Register" ]) cellend() rowend() tableend() formend() divend() divend() } Screen Shot: The Registration response #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" 45.21. Users registration and Login 335](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-358-2048.jpg)
![Ring Documentation, Release 1.4.1 Import System.Web oUser = new UsersModel oUser.Connect() if oUser.findwith("username",aPageVars["username"]) new page { text("The user name is already registered") } return ok if oUser.findwith("email",aPageVars["email"]) new page { text("This email is already registered") } return ok aPageVars["salt"] = str2hex(RandBytes(32)) aPageVars["pwhash"] = sha256(aPagevars["password"]+aPageVars["salt"]) aPageVars["sessionid"] = str2hex(randbytes(32)) oUser.Insert() new page { cookie("sessionid",aPageVars["sessionid"]) text("New User Created!") newline() text("User Name : " + aPageVars["username"]) newline() } oUser.Disconnect() See the next code for the Login page #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Import System.Web website = "ex28.ring" new page { boxstart() text( "Login") newline() boxend() divstart([:style = stylegradient(6) + stylesize("100%","95%") ]) link([ :url = website, :title = "back" , :style = stylecolor("white")]) newline() divstart([ :style= styledivcenter("500","130") + stylegradient(52) ]) formpost("ex29.ring") tablestart([ :Style = stylemarginleft("2%") + stylemargintop("2%") + stylewidth("90%") ]) rowstart([]) cellstart([:style = stylewidth("20%") + styleheight(30)]) text("User Name") cellend() cellstart([ :style = stylewidth("80%") ]) textbox([:name = "username", :style = stylewidth("100%")]) cellend() 45.21. Users registration and Login 336](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-359-2048.jpg)
![Ring Documentation, Release 1.4.1 rowend() rowstart([]) cellstart([ :style = styleheight(30)]) text("Password") cellend() cellstart([]) textbox([:name = "password" , :type = "password"]) cellend() rowend() rowstart([]) cellstart([ :style = styleheight(30) ]) cellend() cellstart([]) submit([:value = "Login" ]) cellend() rowend() tableend() formend() divend() divend() } Screen Shot: The response page #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" Import System.Web 45.21. Users registration and Login 337](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-360-2048.jpg)
![Ring Documentation, Release 1.4.1 oUser = new UsersModel oUser.Connect() lResult = oUser.FindWith("username",aPageVars["username"]) new page { if lResult if sha256(aPagevars["password"]+oUser.Salt) = oUser.pwhash text ("Correct Password!") aPageVars["sessionid"] = str2hex(randbytes(32)) oUser.UpdateColumn("sessionid",aPageVars["sessionid"]) cookie("sessionid",aPageVars["sessionid"]) else text ("Bad password!") ok else text("Bad User Name!") ok } oUser.Disconnect() The next code for checking if the user needs to login or not #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" Import System.Web oUser = new UsersModel oUser.Connect() lResult = oUser.FindWith("sessionid",aPageVars["sessionid"]) new page { if lResult text("User Name : " + oUser.username ) else text("Please Login First!") ok } oUser.Disconnect() 45.22 Database, ModelBase & ControllerBase classes In this section we will see some code from datalib.ring The next code presents the Database, ModelBase & ControllerBase classes Import System.Web Class Database cServer = "localhost" cUserName = "root" cPassword = "root" cDatabase = "mahdb" Func Connect 45.22. Database, ModelBase & ControllerBase classes 338](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-361-2048.jpg)
![Ring Documentation, Release 1.4.1 con = mysql_init() mysql_connect(con, cServer, cUserName, cPassWord,cDatabase) Func Disconnect mysql_close(con) Func Query cQuery mysql_query(con,cQuery) Func QueryResult return mysql_result(con) Func QueryResultWithColumns # return columns names + query result return mysql_result2(con) Func QueryValue aResult = mysql_result(con) if islist(aResult) and len(aResult) >= 1 aResult = aResult[1] if len(aResult) >= 1 return aResult[1] ok ok return 0 Func EscapeString x if isstring(x) return MySQL_Escape_String(con,x) else return MySQL_Escape_String(con,string(x)) ok Private con = NULL Class ModelBase from Database cTableName = "" cSearchColumn = "name" aColumns = [] aQueryResult = [] ID = 0 # set table name from class name classname = lower(classname(self)) if right(classname,5) = :model cTablename = left(classname,len(classname)-5) ok Func Insert cValues = "" for x in aColumns cValues += "'" + EscapeString(aPageVars[x]) + "'," 45.22. Database, ModelBase & ControllerBase classes 339](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-362-2048.jpg)
![Ring Documentation, Release 1.4.1 Next cValues = left(cValues,len(cValues)-1) # remove last comma cColumns = "" for x in aColumns cColumns += x + "," next cColumns = left(cColumns,len(cColumns)-1) query("insert into " + cTableName + "("+cColumns+") values (" + cValues + ")" ) Func Update nID cStr = "" for x in aColumns cStr += x + " = '" + EscapeString(aPageVars[x]) + "' , " # the space after comma is necessary Next cStr = left(cStr,len(cStr)-2) query("update " + cTableName + " set " + cStr + " where id = " + nID ) Func UpdateColumn cColumn,cValue query("update " + cTableName + " set " + cColumn + " = '" + EscapeString(cValue) + "' where id = " + self.ID ) Func Count cValue query("SELECT count(*) FROM " + cTableName + " where "+cSearchColumn+" like '" + EscapeString(cValue) + "%'") return queryValue() Func Read nStart,nRecordsPerPage query("SELECT * FROM "+ cTableName+" limit " + EscapeString(nStart) + "," + EscapeString(nRecordsPerPage) ) aQueryResult = queryResult() Func Search cValue,nStart,nRecordsPerPage query("SELECT * FROM "+ cTableName+" where "+cSearchColumn+" like '" + EscapeString(cValue) + "%'" + " limit " + EscapeString(nStart) + "," + EscapeString(nRecordsPerPage) ) aQueryResult = queryResult() Func Find nID query("select * from " + cTableName + " where id = " + EscapeString(nID) ) aResult = queryResult()[1] # move the result from the array to the object attributes ID = nID cCode = "" for x = 2 to len(aResult) cCode += aColumns[x-1] + " = hex2str('" + str2hex(aResult[x]) + "')" + nl next eval(cCode) Func FindWith cColumn,cValue 45.22. Database, ModelBase & ControllerBase classes 340](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-363-2048.jpg)
![Ring Documentation, Release 1.4.1 query("select * from " + cTableName + " where "+cColumn+" = '" + EscapeString(cValue) + "'" ) aResult = queryResult() if len(aResult) > 0 aResult = aResult[1] else return 0 ok # move the result from the array to the object attributes ID = aResult[1] cCode = "" for x = 2 to len(aResult) cCode += aColumns[x-1] + " = hex2str('" + str2hex(aResult[x]) + "')" + nl next eval(cCode) return 1 Func Delete ID query("delete from " + cTableName + " where id = " + EscapeString(ID) ) Func Clear cCode = "" for x in aColumns cCode += x + ' = ""' + nl next eval(cCode) Func LoadModel # create the columns array query("SELECT * FROM "+ cTableName + " limit 0,1") aQueryResult = QueryResultWithColumns()[1] for x = 2 to len(aQueryResult) aColumns + lower(trim(aQueryResult[x])) next # create attribute for each column for x in aColumns addattribute(self,x) next Func Connect Super.Connect() if nLoadModel = 0 nLoadModel = 1 LoadModel() ok private nLoadModel = 0 Class ControllerBase 45.22. Database, ModelBase & ControllerBase classes 341](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-364-2048.jpg)
![Ring Documentation, Release 1.4.1 nRecordsPerPage = 5 nRecordsCount = 0 nPagesCount = 0 nActivePage = 0 # Dynamic creation of oView = new tablenameView and oModel = new tablename.Model classname = lower(classname(self)) if right(classname,10) = :controller tablename = left(classname,len(classname)-10) cCode = "oView = new " + tablename+"View" + nl cCode += "oModel = new " + tablename+"Model" + nl eval(cCode) oModel.connect() ok cSearchName = "searchname" cPart = "part" cPageError = "The page number is not correct" cLast = "last" cOperation = "operation" cRecID = "recid" aColumnsNames = ["id"] for t in oModel.aColumns aColumnsNames + t next cMainURL = website + "?" func Routing switch aPageVars[cOperation] on NULL showtable() on :add addrecord() on :save saverecord() on :delete deleterecord() on :edit editrecord() on :update updaterecord() off func ShowTable nRecordsCount = oModel.Count( aPageVars[cSearchName] ) nPagesCount = ceil(nRecordsCount / nRecordsPerPage) if aPageVars[cPart] = cLast aPageVars[cPart] = string(nPagesCount) ok nActivePage = number(aPageVars[cPart]) if nActivePage = 0 nActivePage = 1 ok if ( nActivePage > nPagesCount ) and nRecordsCount > 0 ErrorMsg(cPageError) return ok 45.22. Database, ModelBase & ControllerBase classes 342](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-365-2048.jpg)
![Ring Documentation, Release 1.4.1 nStart = (nActivePage-1)*nRecordsPerPage if aPageVars[cSearchName] = NULL oModel.Read( nStart,nRecordsPerPage ) else oModel.Search( aPageVars[cSearchName],nStart,nRecordsPerPage ) ok oView.GridView(self) func AddRecord oModel.clear() oView.FormViewAdd(Self,:save,false) # false mean don't include record id func SaveRecord oModel.Insert() oView.SaveView(self) func EditRecord oModel.Find( aPageVars[cRecID] ) oView.FormViewEdit(Self,:update,true) # true mean include record id func UpdateRecord oModel.update( aPageVars[cRecID] ) oView.UpdateView(self) func DeleteRecord oModel.Delete( aPageVars[cRecID] ) oView.DeleteView() func braceend oModel.Disconnect() 45.23 WebLib API In this section we will see the web library functions, classes and methods. Function Parameters Description LoadVars None Save the request parameters and cookies to aPageVars List WebPage None Create new object from the WebPage Class BootStrapWebPage None Create new object from the BootStrapWebPage Class HTMLSpecialChars cString Encode Special characters to HTML equivalent Template cFile,oObject Execute Ring Code in cFile after accessing oObject using {} Alert cMessage Generate HTML Web Page that display cMessage using JavaScript Alert() HTML2PDF cString Generate and Display PDF File from HTML String (cString) The Package System.Web contains the next classes 45.23. WebLib API 343](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-366-2048.jpg)
![Ring Documentation, Release 1.4.1 al_draw_bitmap(bouncer, bouncer_x, bouncer_y, 0) al_draw_bitmap(bouncer, 200+bouncer_x,200+ bouncer_y, 0) al_flip_display() al_rest(0.1) next al_clear_to_color(al_map_rgb(255,255,255)) image = al_load_bitmap("man2.jpg") al_draw_bitmap(image,200,200,0) al_flip_display() al_rest(2) event_queue = al_create_event_queue() al_register_event_source(event_queue, al_get_display_event_source(display)) ev = al_new_allegro_event() timeout = al_new_allegro_timeout() al_init_timeout(timeout, 0.06) FPS = 60 timer = al_create_timer(1.0 / FPS) al_register_event_source(event_queue, al_get_timer_event_source(timer)) al_start_timer(timer) redraw = true SCREEN_W = 640 SCREEN_H = 480 BOUNCER_SIZE = 32 bouncer_x = SCREEN_W / 2.0 - BOUNCER_SIZE / 2.0 bouncer_y = SCREEN_H / 2.0 - BOUNCER_SIZE / 2.0 bouncer_dx = -4.0 bouncer_dy = 4.0 al_install_mouse() al_register_event_source(event_queue, al_get_mouse_event_source()) al_install_keyboard() al_register_event_source(event_queue, al_get_keyboard_event_source()) KEY_UP = 1 KEY_DOWN = 2 KEY_LEFT = 3 KEY_RIGHT = 4 Key = [false,false,false,false] while true al_wait_for_event_until(event_queue, ev, timeout) switch al_get_allegro_event_type(ev) on ALLEGRO_EVENT_DISPLAY_CLOSE exit on ALLEGRO_EVENT_TIMER # Animation if bouncer_x < 0 or bouncer_x > SCREEN_W - BOUNCER_SIZE bouncer_dx = -bouncer_dx ok if bouncer_y < 0 or bouncer_y > SCREEN_H - BOUNCER_SIZE 48.1. Drawing, Animation and Input 357](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-380-2048.jpg)
![Ring Documentation, Release 1.4.1 bouncer_dy = -bouncer_dy ok bouncer_x += bouncer_dx bouncer_y += bouncer_dy # Keyboard if key[KEY_UP] and bouncer_y >= 4.0 bouncer_y -= 4.0 ok if key[KEY_DOWN] and bouncer_y <= SCREEN_H - BOUNCER_SIZE - 4.0 bouncer_y += 4.0 ok if key[KEY_LEFT] and bouncer_x >= 4.0 bouncer_x -= 4.0 ok if key[KEY_RIGHT] and bouncer_x <= SCREEN_W - BOUNCER_SIZE - 4.0 bouncer_x += 4.0 ok redraw = true on ALLEGRO_EVENT_MOUSE_AXES bouncer_x = al_get_allegro_event_mouse_x(ev) bouncer_y = al_get_allegro_event_mouse_y(ev) on ALLEGRO_EVENT_MOUSE_ENTER_DISPLAY bouncer_x = al_get_allegro_event_mouse_x(ev) bouncer_y = al_get_allegro_event_mouse_y(ev) on ALLEGRO_EVENT_MOUSE_BUTTON_UP exit on ALLEGRO_EVENT_KEY_DOWN switch al_get_allegro_event_keyboard_keycode(ev) on ALLEGRO_KEY_UP key[KEY_UP] = true on ALLEGRO_KEY_DOWN key[KEY_DOWN] = true on ALLEGRO_KEY_LEFT key[KEY_LEFT] = true on ALLEGRO_KEY_RIGHT key[KEY_RIGHT] = true off on ALLEGRO_EVENT_KEY_UP switch al_get_allegro_event_keyboard_keycode(ev) on ALLEGRO_KEY_UP key[KEY_UP] = false on ALLEGRO_KEY_DOWN key[KEY_DOWN] = false on ALLEGRO_KEY_LEFT key[KEY_LEFT] = false on ALLEGRO_KEY_RIGHT key[KEY_RIGHT] = false on ALLEGRO_KEY_ESCAPE exit off off if redraw and al_is_event_queue_empty(event_queue) redraw = false al_clear_to_color(al_map_rgb(0,0,0)) 48.1. Drawing, Animation and Input 358](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-381-2048.jpg)
![Ring Documentation, Release 1.4.1 Switch nKey on KEY_LEFT x -= 10 on KEY_RIGHT x += 10 on KEY_UP y -= 10 on KEY_DOWN y += 10 off } } mouse = func oGame,oSelf,nType,aMouseList { if nType = GE_MOUSE_UP oSelf { x = aMouseList[GE_MOUSE_X] y = aMouseList[GE_MOUSE_Y] } ok } } } # Start the Events Loop 50.22 Using the Game Engine - Sprite - State event Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" sprite { type = GE_TYPE_PLAYER # Just for our usage x=400 y=400 width=100 height=100 file = "images/player.png" transparent = true Animate=false Move=false # Custom Movement Scaled=true keypress = func oGame,oSelf,nKey { oSelf { Switch nKey on KEY_LEFT x -= 10 on KEY_RIGHT x += 10 on KEY_UP y -= 10 on KEY_DOWN y += 10 off } } mouse = func oGame,oSelf,nType,aMouseList { 50.22. Using the Game Engine - Sprite - State event 390](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-413-2048.jpg)
![Ring Documentation, Release 1.4.1 if nType = GE_MOUSE_UP oSelf { x = aMouseList[GE_MOUSE_X] y = aMouseList[GE_MOUSE_Y] } ok } state = func oGame,oSelf { oself { if x < 0 x = 0 ok if y < 0 y = 0 ok if x > ogame.width-width x= ogame.width - width ok if y > ogame.height-height y=ogame.height - height ok } } } } # Start the Events Loop 50.23 Using the Game Engine - Animate - Events Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" animate { file = "images/fbbird.png" x = 10 y = 10 framewidth = 20 scaled = true height = 50 width = 50 nStep = 3 transparent = true state = func oGame,oSelf { oSelf { # Animation nStep-- if nStep = 0 nStep = 3 if frame < 3 frame++ else frame=1 ok ok 50.23. Using the Game Engine - Animate - Events 391](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-414-2048.jpg)
![Ring Documentation, Release 1.4.1 50.24 Using the Game Engine - Map Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,1,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], 50.24. Using the Game Engine - Map 393](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-416-2048.jpg)
![Ring Documentation, Release 1.4.1 [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0] ] aImages = ["images/fbwall.png", "images/fbwallup.png", "images/fbwalldown.png"] state = func oGame,oSelf { oSelf { x -= 3 if x < - 2100 x = 0 ok } } } } # Start the Events Loop Screen Shot: 50.24. Using the Game Engine - Map 394](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-417-2048.jpg)
![Ring Documentation, Release 1.4.1 50.25 Using the Game Engine - Map Events Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,1,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0] ] aImages = ["images/fbwall.png", "images/fbwallup.png", "images/fbwalldown.png"] state = func oGame,oSelf { oSelf { x -= 3 if x < - 2100 x = 0 ok } } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP oSelf { mX = aMouseList[GE_MOUSE_X] mY = aMouseList[GE_MOUSE_Y] nValue = GetValue(mX,mY) nRow = GetRow(mX,mY) nCol = GetCol(mX,mY) Switch nValue On 1 aMap[nRow][nCol] = 0 On 2 aMap[nRow][nCol] = 0 On 3 aMap[nRow][nCol] = 0 On 0 aMap[nRow][nCol] = 1 Off } ok } } } # Start the Events Loop 50.25. Using the Game Engine - Map Events 395](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-418-2048.jpg)
![Ring Documentation, Release 1.4.1 state = func ogame,oself { oself { if x < -350 direction = ge_direction_inc point = 370 but x = 0 and direction = ge_direction_inc direction = ge_direction_dec point = -370 ok } } } sprite { file = "images/player.png" transparent = true type = ge_type_player x = 400 y =400 width=100 height=100 animate=false move=true Scaled=true mouse = func ogame,oself,nType,aMouseList { if not ( aMouseList[GE_MOUSE_X] >= oSelf.x and aMouseList[GE_MOUSE_X] <= oSelf.x+oSelf.width and aMouseList[GE_MOUSE_Y] >= oself.y and aMouseList[GE_MOUSE_Y] <= oSelf.y+oSelf.height ) if nType = GE_MOUSE_DOWN if aMouseList[1] < oSelf.X # left oSelf.X -= 100 else oSelf.X += 100 ok if aMouseList[2] < oSelf.Y # up oSelf.Y -= 100 else oSelf.Y += 100 ok ok else if nType = GE_MOUSE_UP cFunc = oself.keypress call cFunc(oGame,oSelf,Key_Space) ok ok } keypress = func oGame,oself,nkey { if nkey = key_space ogame { sprite { type = ge_type_fire file = "images/rocket.png" transparent = true x = oself.x + 30 y = oself.y - 30 width = 30 height = 30 point = -30 50.27. Stars Fighter Game 402](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-425-2048.jpg)
![Ring Documentation, Release 1.4.1 point = ogame.screen_h+30 nstep = 10 direction = ge_direction_incvertical state = func oGame,oSelf { x = oGame.aObjects[oGameState.playerindex] if oself.x >= x.x and oself.y >= x.y and oself.x <= x.x + x.width and oself.y <= x.y + x.height if oGameState.value > 0 oGameState.value-=10 ok ogame.remove(oself.nindex) checkgameover(oGame) ok } } } ok } } next text { size = 30 file = "fonts/pirulen.ttf" text = "Destroy All Enemies!" nstep = 3 color = GE_COLOR_GREEN x = 100 y=50 direction = ge_direction_incvertical point = 500 } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Score : " + oGameState.score x = 500 y=10 state = func oGame,oSelf { oSelf { text = "Score : " + oGameState.score } } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Energy : " + oGameState.value x = 500 y=50 state = func oGame,oSelf { oSelf { text = "Energy : " + oGameState.value } } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Level : " + oGameState.level x = 500 y=90 } } 50.27. Stars Fighter Game 404](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-427-2048.jpg)
![Ring Documentation, Release 1.4.1 } } } showfire(oGame,oGame.aObjects[oGameState.PlayerIndex].x+40, oGame.aObjects[oGameState.PlayerIndex].y+40) oGame.aObjects[oGameState.PlayerIndex].enabled = false oGame.remove(oGameState.PlayerIndex) ok func showfire oGame,nX,nY oGame { animate { file = "images/fire.png" x = nX y = nY framewidth = 40 height = 42 nStep = 3 transparent = true state = func oGame,oSelf { oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 13 frame++ else frame=1 oGame.remove(oself.nIndex) ok ok } } } } class gamestate score = 0 level = 1 enemies = 1 value = 100 playerindex = 2 gameresult = false startplay=false Screen Shot: 50.27. Stars Fighter Game 406](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-429-2048.jpg)
![Ring Documentation, Release 1.4.1 file = "images/fbback.png" x = 0 y=0 width=800 height = 600 scaled = true animate = false keypress = func ogame,oself,nKey { if nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() ok } } Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,1,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0] ] newmap(aMap) aImages = ["images/fbwall.png","images/fbwallup.png", "images/fbwalldown.png"] state = func oGame,oSelf { if oGameState.gameresult = false px = oGame.aObjects[3].x py = oGame.aObjects[3].y oSelf { x -= 3 if x < - 2100 x = 0 newmap(aMap) ok nCol = getcol(px,0) if nCol=11 or nCol=15 or nCol=19 or nCol=23 or nCol=27 if nCol != oGameState.lastcol oGameState.lastcol = nCol oGameState.Score += 100 oGame { Sound { once = true file = "sound/sfx_point.wav" } } checkwin(oGame) ok ok } if oSelf.getvalue(px+40,py) != 0 or oSelf.getvalue(px+40,py+40) != 0 or oSelf.getvalue(px,py) != 0 or oSelf.getvalue(px,py+40) != 0 oGameState.gameresult = true oGame { text { point = 550 size = 30 nStep = 3 50.28. Flappy Bird 3000 Game 410](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-433-2048.jpg)
![Ring Documentation, Release 1.4.1 ok ok } keypress = func ogame,oself,nKey { if oGameState.gameresult = false oself { if nkey = key_space y -= 55 oGameState.down = 60 if y<=0 y=0 ok ok } ok } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP cFunc = oself.keypress call cFunc(oGame,oSelf,Key_Space) ok } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Score : " + oGameState.score x = 500 y=10 state = func oGame,oSelf { oSelf { text = "Score : " + oGameState.score } } } } func newmap aMap aV = [ [1,1,3,0,0,2,1,1], [1,3,0,0,0,2,1,1], [1,1,1,3,0,2,1,1], [1,1,1,3,0,0,0,0], [0,0,0,0,2,1,1,1], [0,0,2,1,1,1,1,1], [0,0,0,2,1,1,1,1], [1,1,1,3,0,2,1,1], [1,1,1,1,1,3,0,0], [3,0,0,2,1,1,1,1], [3,0,0,2,3,0,0,2] ] for x = 10 to 24 step 4 aVar = aV[ (random(10)+1) ] for y = 1 to 8 aMap[y][x] = aVar[y] next next 50.28. Flappy Bird 3000 Game 412](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-435-2048.jpg)
![Ring Documentation, Release 1.4.1 Sprite { file = "images/supermancity.jpg" x = 0 y=0 width=800 height = 600 scaled = true animate = false } Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,4,4,4,0,0,0,1,0,0,0,1,4,4,0,1,0,0,0,0,4,4,0,1,4, 4,4,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,0,1,0,0,0,1,0,0,0,1,0,3,3,3,5,3,3,3,3,0], [0,0,4,0,4,0,4,0,0,1,0,0,0,3,4,4,4,1,0,0,0,0,4,4,0,1,4, 4,4,0,0,4,4,4,4,4,4,4,4,4,4,4,4,1,4,1,0,0,0,1,0,0,0,1,0,4,4,4,4,4,4,4,4,0], [0,0,0,4,4,4,0,0,0,1,0,0,0,4,4,4,4,1,0,0,0,0,0,0,0,3,4, 4,4,0,0,4,0,0,0,0,0,0,4,2,0,0,4,1,4,1,4,2,4,1,0,2,0,1,0,4,4,4,4,4,4,4,4,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0, 0,0,0,0,4,4,4,4,4,4,4,4,1,0,0,4,1,4,1,4,1,4,1,0,1,0,1,0,2,2,2,2,2,2,2,2,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0, 0,0,0,0,2,0,0,0,0,0,2,0,3,0,0,0,1,4,1,4,1,4,1,0,1,0,1,0,1,0,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0,2,0,0,0,0,0, 0,0,0,0,1,0,0,0,0,0,1,0,0,0,0,0,1,4,3,4,1,4,3,0,1,0,3,0,1,0,0,0,0,0,0,0,0], [0,0,2,0,0,2,0,0,2,1,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,0,0, 0,0,0,0,1,0,0,0,0,0,3,0,0,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,0,0,0,0,0], [0,0,1,0,0,1,0,0,1,3,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0, 0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,0,0,0,0,0] ] aImages = ["images/smwall.png","images/smwallup.png", "images/smwalldown.png","images/smstar.png", "images/smkey.png","images/smstar2.png"] } sprite { type = ge_type_enemy animate = false file = "images/smhome.png" x = 5000 y = 400 width = 290 height = 200 transparent = true state = func oGame,oSelf { oself { x = 5000 + oGame.aObjects[2].x if x < 0 or x > SCREEN_W return ok } if oGameState.gameresult or oGameState.DoorKey = false return ok if oGame.aObjects[oGameState.playerindex].x > oself.x + 100 and oGame.aObjects[oGameState.playerindex].y > oself.y + 50 oGameState.gameresult = true oGame { sprite { file = "images/smwin.jpg" x=0 y=0 width=800 height=600 scaled = true animate=false state = func ogame,oself { oself { x-=5 y-=5 50.29. Super Man 2016 Game 417](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-440-2048.jpg)
![Ring Documentation, Release 1.4.1 width +=10 height +=10 if x = -300 ogame.shutdown = true ok } } } } ok } } animate { file = "images/superman.png" x = 0 y = 0 framewidth = 60 scaled = true height = 86 width = 60 nStep = 3 transparent = true state = func oGame,oSelf { checkstarskeycol(oGame,oSelf) if not oGameState.playerwin oself { file = "images/superman.png" height = 86 width = 60 for t=1 to 8 if checkwall2(oGame,oSelf,0,5,[2,1]) y += 5 else exit ok next if y > 500 y=500 ok } ok } keypress = func ogame,oself,nKey { if oGameState.gameresult = false oself { if nkey = key_up and checkwall(oGame,oSelf,0,-40) oGameState.value -= 1 checkgameover(oGame) file = "images/supermanup.png" height = 123 dotransparent() y -= 40 oGameState.down = 10 if y<=0 y=0 ok 50.29. Super Man 2016 Game 418](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-441-2048.jpg)
![Ring Documentation, Release 1.4.1 but nkey = key_down and checkwall(oGame,oSelf,0,40) file = "images/supermandown.png" dotransparent() y += 40 if y>=500 y=500 ok but nKey = key_right and checkwall(oGame,oSelf,10,0) file = "images/supermanright.png" dotransparent() x += 10 if x >= 440 if oGame.aObjects[2].x > -4500 oGame.aObjects[2].x -= 50 callenemystate(oGame) else if x <= 750 if checkwall(oGame,oSelf,10,0) x += 10 ok else if checkwall(oGame,oSelf,-10,0) x -= 10 ok ok return ok x=400 ok but nKey = key_left and checkwall(oGame,oSelf,-10,0) file = "images/supermanleft.png" dotransparent() x -= 10 if x <= 0 x += 10 if oGame.aObjects[2].x != 0 oGame.aObjects[2].x += 50 callenemystate(oGame) x += 50 ok ok but nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() ok } ok } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_DOWN oGameState.moveplayer = TRUE But nType = GE_MOUSE_UP oGameState.moveplayer = FALSE ok if oGameState.moveplayer = TRUE if aMouseList[GE_MOUSE_X] < oSelf.X # left cFunc = oself.keypress call cFunc(oGame,oSelf,Key_left) else cFunc = oself.keypress call cFunc(oGame,oSelf,Key_right) 50.29. Super Man 2016 Game 419](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-442-2048.jpg)
![Ring Documentation, Release 1.4.1 ok if aMouseList[GE_MOUSE_Y] < oSelf.Y # up cFunc = oself.keypress call cFunc(oGame,oSelf,Key_up) else cFunc = oself.keypress call cFunc(oGame,oSelf,Key_down) ok ok } } addenemy(oGame,600) addenemy(oGame,900) addenemy(oGame,1550) addenemy(oGame,2350) addenemy(oGame,3350) addenemy(oGame,3500) addenemy(oGame,3670) addenemy(oGame,3840) text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Score : " + oGameState.score x = 500 y=0 state = func oGame,oSelf { oSelf { text = "Score : " + oGameState.score } } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Energy : " + oGameState.value x = 10 y=0 state = func oGame,oSelf { oSelf { text = "Energy : " + oGameState.value } } } } func inlist nValue,aList for x in aList if x = nValue return true ok next return false func checkwall oGame,oself,diffx,diffy alist = [1,2,3] return checkwall2(oGame,oself,diffx,diffy,aList) func checkwall2 oGame,oself,diffx,diffy,aList 50.29. Super Man 2016 Game 420](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-443-2048.jpg)
![Ring Documentation, Release 1.4.1 xPos = oSelf.x + diffx yPos = oSelf.y + diffy nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok xPos = oSelf.x + diffx yPos = oSelf.y + diffy + oSelf.height nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok xPos = oSelf.x + diffx + oSelf.width yPos = oSelf.y + diffy nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok xPos = oSelf.x + diffx + oSelf.width yPos = oSelf.y + diffy + oSelf.height nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok return nValue func checkopenwall oGame if oGameState.score = 900 oGame.aObjects[2].aMap[3][10] = 3 oGame.aObjects[2].aMap[4][10] = 0 oGame.aObjects[2].aMap[5][10] = 0 oGame.aObjects[2].aMap[6][10] = 0 oGame.aObjects[2].aMap[7][10] = 0 oGame.aObjects[2].aMap[8][10] = 0 but oGameState.score = 1800 oGame.aObjects[2].aMap[3][18] = 3 oGame.aObjects[2].aMap[4][18] = 0 oGame.aObjects[2].aMap[5][18] = 0 oGame.aObjects[2].aMap[6][18] = 0 oGame.aObjects[2].aMap[7][18] = 0 oGame.aObjects[2].aMap[8][18] = 0 but oGameState.score = 5500 oGame.aObjects[2].aMap[1][44] = 0 oGame.aObjects[2].aMap[2][44] = 0 oGame.aObjects[2].aMap[3][44] = 2 ok func checkgameover ogame if oGameState.gameresult return ok if oGameState.value <= 0 oGameState.value = 0 oGameState.gameresult = true oGame { 50.29. Super Man 2016 Game 421](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-444-2048.jpg)
![Ring Documentation, Release 1.4.1 text { point = 400 size = 30 nStep = 9 file = "fonts/pirulen.ttf" text = "Game Over !!!" x = 500 y=10 state = func ogame,oself { if oself.y >= 400 ogame.shutdown = true ok } } } showfire(oGame,oGame.aObjects[oGameState.PlayerIndex].x+40, oGame.aObjects[oGameState.PlayerIndex].y+40) oGame.aObjects[oGameState.PlayerIndex].enabled = false oGame.remove(oGameState.PlayerIndex) ok func showfire oGame,nX,nY oGame { animate { file = "images/fire.png" x = nX y = nY framewidth = 40 height = 42 nStep = 3 transparent = true state = func oGame,oSelf { oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 13 frame++ else frame=1 oGame.remove(oself.nIndex) ok ok } } } } func addenemy oGame,xPos oGame { lbraceend = false sprite { type = ge_type_enemy file = "images/smenemy.png" transparent = true x = xPos y =10 width=100 height=100 animate=true Scaled=true direction = GE_DIRECTION_NOMOVE 50.29. Super Man 2016 Game 422](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-445-2048.jpg)
![Ring Documentation, Release 1.4.1 temp = xPos state = func oGame,oSelf { oself { x = oSelf.temp + oGame.aObjects[2].x if y < 0 y = 0 ok if y > 100 y=100 ok if x > SCREEN_W or x < 0 return ok } if random(10) = 1 if oGameState.gameresult return ok ogame { sprite { type = ge_type_fire file = "images/smrocket.png" scaled = true transparent = true x = oself.x + 30 y = oself.y + oself.height+ 30 width = 30 height = 30 point = ogame.screen_h+30 nstep = 30 direction = ge_direction_incvertical xvalue = oGame.aObjects[2].x temp = oself.x + 30 - xvalue state = func oGame,oSelf { oself { x = oSelf.temp + oGame.aObjects[2].x } x = oGame.aObjects[oGameState.playerindex] if oself.x >= x.x and oself.y >= x.y and oself.x <= x.x + x.width and oself.y <= x.y + x.height if oGameState.value > 0 oGameState.value-=1000 ok ogame.remove(oself.nindex) checkgameover(oGame) ok } } } ok } } } ogame.lbraceend = true func checkstarskey oGame,oSelf,nValue,nRow,nCol switch nValue on 4 oGame.aObjects[2].aMap[nRow][nCol] = 6 oGameState.Score += 100 checkopenwall(oGame) oGame { Sound { once = true file = "sound/sfx_point.wav" } } 50.29. Super Man 2016 Game 423](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-446-2048.jpg)
![Ring Documentation, Release 1.4.1 on 5 oGame.aObjects[2].aMap[nRow][nCol] = 0 oGameState.DoorKey = true oGameState.Score += 500 checkopenwall(oGame) oGame { Sound { once = true file = "sound/sfx_point.wav" } } off func checkstarskeycol oGame,oSelf nValue = oGame.aObjects[2].getvalue(oSelf.x,oSelf.y) nRow = oGame.aObjects[2].getrow(oSelf.x,oSelf.y) nCol = oGame.aObjects[2].getcol(oSelf.x,oSelf.y) checkstarskey(oGame,oSelf,nValue,nRow,nCol) nValue = oGame.aObjects[2].getvalue(oSelf.x+oSelf.width,oSelf.y+oSelf.height) nRow = oGame.aObjects[2].getrow(oSelf.x+oSelf.width,oSelf.y+oSelf.height) nCol = oGame.aObjects[2].getcol(oSelf.x+oSelf.width,oSelf.y+oSelf.height) checkstarskey(oGame,oSelf,nValue,nRow,nCol) nValue = oGame.aObjects[2].getvalue(oSelf.x+oSelf.width,oSelf.y) nRow = oGame.aObjects[2].getrow(oSelf.x+oSelf.width,oSelf.y) nCol = oGame.aObjects[2].getcol(oSelf.x+oSelf.width,oSelf.y) checkstarskey(oGame,oSelf,nValue,nRow,nCol) nValue = oGame.aObjects[2].getvalue(oSelf.x,oSelf.y+oSelf.height) nRow = oGame.aObjects[2].getrow(oSelf.x,oSelf.y+oSelf.height) nCol = oGame.aObjects[2].getcol(oSelf.x,oSelf.y+oSelf.height) checkstarskey(oGame,oSelf,nValue,nRow,nCol) func callenemystate oGame for t in oGame.aObjects t { if type = GE_TYPE_ENEMY call state(oGame,t) ok } next Class GameState down = 3 gameresult = false Score = 0 startplay=false lastcol = 0 playerwin = false DoorKey = false playerindex = 4 value = 1000 moveplayer = false Screen Shot: 50.29. Super Man 2016 Game 424](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-447-2048.jpg)
![Ring Documentation, Release 1.4.1 52.4 Using the QListWidget Class In this example we will use the QListWidget Class Load "guilib.ring" New qApp { win1 = new qWidget() { setGeometry(100,100,400,400) list1 = new qlistwidget(win1) { setGeometry(150,100,200,200) alist = ["one","two","three","four","five"] for x in alist additem(x) next setcurrentrow(3,2) win1.setwindowtitle("Items Count : " + count() ) } 52.4. Using the QListWidget Class 433](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-456-2048.jpg)
![Ring Documentation, Release 1.4.1 Another Example: Load "guilib.ring" New qApp { win1 = new qWidget() { setGeometry(100,100,500,400) list1 = new qlistwidget(win1) { setGeometry(150,100,200,200) alist = ["one","two","three","four","five"] for x in alist additem(x) next setcurrentrow(3,2) win1.setwindowtitle("Items Count : " + count() ) } btn1 = new qpushbutton(win1) { setGeometry(10,200,100,30) settext("selected item") setclickevent("pWork()") } btn2 = new qpushbutton(win1) { setGeometry(10,240,100,30) settext("Delete item") setclickevent("pWork2()") } show() } exec() } func pWork nbrOfItems = list1.count() curItemNbr = list1.currentrow() curValue = list1.item(list1.currentrow()).text() win1.setwindowtitle( "After Select - NbrOfItems: " + nbrOfItems + " CurItemNbr: " + curItemNbr + " CurValue: " + curValue ) btn1.settext( string(list1.currentrow() ) + " --- " + list1.item(list1.currentrow()).text() ) func pWork2 list1 { takeitem(currentrow()) nbrOfItems = count() curItemNbr = currentrow() curValue = item(currentrow()).text() 52.4. Using the QListWidget Class 435](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-458-2048.jpg)
![Ring Documentation, Release 1.4.1 Load "guilib.ring" New qApp { win1 = new qWidget() { setwindowtitle("Using QComboBox") setGeometry(100,100,400,400) New QComboBox(win1) { setGeometry(150,100,200,30) alist = ["one","two","three","four","five"] for x in aList additem(x,0) next } show() } exec() } The application during the runtime 52.8 Creating Menubar In this example we will learn about using the QMenuBar class 52.8. Creating Menubar 439](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-462-2048.jpg)
![Ring Documentation, Release 1.4.1 52.9 Creating Toolbar In this example we will learn about using the QToolBar class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("Using QToolbar") setGeometry(100,100,600,400) abtns = [ new qpushbutton(win1) { settext("Add") } , new qpushbutton(win1) { settext("Edit") } , new qpushbutton(win1) { settext("Find") } , new qpushbutton(win1) { settext("Delete") } , new qpushbutton(win1) { settext("Exit") setclickevent("win1.close()") } ] tool1 = new qtoolbar(win1) { for x in abtns addwidget(x) addseparator() next setmovable(true) setGeometry(0,0,500,30) 52.9. Creating Toolbar 442](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-465-2048.jpg)
![Ring Documentation, Release 1.4.1 Load "guilib.ring" oApp = new myapp { start() } Class MyApp oColor win1 Func start myapp = new qapp win1 = new qMainWindow() { setwindowtitle("Color Dialog") setgeometry(100,100,400,400) } new qpushbutton(win1) { setgeometry(10,10,100,30) settext("Get Color") setclickevent("oApp.pColor()") } win1.show() myapp.exec() Func pColor myobj = new qcolordialog() aColor = myobj.GetColor() r=acolor[1] g=acolor[2] b=acolor[3] win1.setstylesheet("background-color: rgb("+r+", " + g+ "," + b + ")") The application during the runtime 52.37. Using the QColorDialog Class 479](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-502-2048.jpg)
![Ring Documentation, Release 1.4.1 aList = [text1,text2,text3,text4] oFilter = new qallevents(win) oFilter.setKeyPressEvent("pWork()") installeventfilter(oFilter) show() } exec() } func pWork nCode = oFilter.getkeycode() if nCode = 16777220 # ENTER Key for x=1 to len(aList) if aList[x].HasFocus() t = x+1 if t > len(aList) t=1 ok aList[t].SetFocus(0) exit ok next ok 52.49 Regular Expressions The next example uses the Regular Expressions classes. load "guilib.ring" new qApp { see "Using Regular Expressions" + nl exp = new qregularexpression() { setPattern("dd w+") see pattern() + nl match = match("33 one",0,0,0) see match.hasmatch() + nl match = match("3 one",0,0,0) see match.hasmatch() + nl match = match("welcome 11 one",0,0,0) see match.hasmatch() + nl matched = match.captured(0) see matched + nl } exp = new qregularexpression() { setPattern("^(dd)/(dd)/(dddd)$") see pattern() + nl match = match("08/12/1985",0,0,0) see match.hasmatch() + nl day = match.captured(1) month = match.captured(2) year = match.captured(3) see day + nl + month + nl + year + nl see "(" + match.capturedStart(1) + "," + match.capturedEnd(1)+ ")" + nl see "(" + match.capturedStart(2) + "," + match.capturedEnd(2)+ ")" + nl see "(" + match.capturedStart(3) + "," + match.capturedEnd(3)+ ")" + nl 52.49. Regular Expressions 495](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-518-2048.jpg)
![Ring Documentation, Release 1.4.1 cOutput += "Accept Connection" + nl lineedit1.settext(cOutput) oTcpClient { cStr ="Hello from server to client!"+char(13)+char(10) write(cStr,len(cStr)) flush() waitforbyteswritten(300000) close() } The application during the runtime 52.51 Dynamic Objects We may create objects in the runtime and add them to windows. Example: load "guilib.ring" oFormDesigner = new FormDesigner { start("oFormDesigner") } Class FormDesigner winToolBox winForm aObjects = [] func start cObjectName oApp = new qApp winToolBox = new qWidget() winToolBox.setWindowTitle("ToolBox") 52.51. Dynamic Objects 498](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-521-2048.jpg)
![Ring Documentation, Release 1.4.1 aIDs = [] win1 = new qWidget() { setWindowTitle("Weight History") resize(600,600) layoutButtons = new qhboxlayout() { label1 = new qLabel(win1) { setText("Weight") } text1 = new qlineedit(win1) btnAdd = new qpushbutton(win1) { setText("Add") setClickEvent($ApplicationObject+".AddWeight()") } btnDelete = new qpushbutton(win1) { setText("Delete") setClickEvent($ApplicationObject+".Deleteweight()") } addwidget(label1) addwidget(text1) addwidget(btnAdd) addwidget(btnDelete) } layoutData = new qhboxlayout() { Table1 = new qTableWidget(win1) { setrowcount(0) setcolumncount(3) setselectionbehavior(QAbstractItemView_SelectRows) setHorizontalHeaderItem(0, new QTableWidgetItem("Date")) setHorizontalHeaderItem(1, new QTableWidgetItem("Time")) setHorizontalHeaderItem(2, new QTableWidgetItem("Weight")) setitemChangedEvent($ApplicationObject+".ItemChanged()") setAlternatingRowColors(true) horizontalHeader().setStyleSheet("color: blue") verticalHeader().setStyleSheet("color: red") } addWidget(Table1) } layoutClose = new qhboxlayout() { btnclose = new qpushbutton(win1) { setText("Close") setClickEvent("MyApp.Quit()") } addwidget(btnClose) } layoutMain = new qvboxlayout() { addlayout(layoutButtons) addLayout(LayoutData) addLayout(layoutClose) } setlayout(layoutMain) self.OpenDatabase() self.ShowRecords() show() } 52.52. Weight History Application 500](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-523-2048.jpg)
![Ring Documentation, Release 1.4.1 Func OpenDatabase lCreate = False if not fexists(cDir + "weighthistory.db") lCreate = True ok new QSqlDatabase() { this.oCon = addDatabase("QSQLITE") { setDatabaseName("weighthistory.db") Open() } } if lCreate new QSqlQuery( ) { exec("create table weighthistory (id integer primary key,"+ " f_date varchar(10),"+ " f_time varchar(8), f_weight varchar(8) );") delete() } ok Func CloseDatabase oCon.Close() Func AddWeight cWeight = text1.text() AddRecord(cWeight) Func DeleteWeight Table1 { nRow = CurrentRow() if nRow >= 0 nID = this.aIDs[nROW+1] new QSqlQuery( ) { exec("delete from weighthistory where id = " + nID ) } Del(this.aIDs,nRow+1) removerow(nRow) selectrow(nRow) ok } Func AddRecord cWeight new QSqlQuery( ) { cStr = "insert into weighthistory (f_date,f_time,f_weight) values"+ " ('%f1','%f2','%f3')" cDate = Date() cTime = Time() cStr = substr(cStr,"%f1",cDate) cStr = substr(cStr,"%f2",cTime) cStr = substr(cStr,"%f3",cWeight) exec(cStr) delete() } ShowRecords() Table1.selectrow(table1.rowcount()-1) 52.52. Weight History Application 501](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-524-2048.jpg)
![Ring Documentation, Release 1.4.1 Func ShowRecords table1.setitemChangedEvent("") aIDs = [] query = new QSqlQuery() { exec("select * from weighthistory") nRows = 0 this.Table1.setrowcount(0) while movenext() this.table1 { insertRow(nRows) this.aIDs + query.value(0).tostring() for x = 1 to 3 cStr = query.value(x).tostring() item = new qTableWidgetItem(cStr) setItem(nRows,x-1,item) next } nRows++ end delete() } table1.setitemChangedEvent($ApplicationObject+".ItemChanged()") Func ItemChanged nRow = table1.currentrow() if nRow >= 0 myitem = Table1.item(table1.currentrow(),0) cDate = myitem.text() myitem = Table1.item(table1.currentrow(),1) cTime = myitem.text() myitem = Table1.item(table1.currentrow(),2) cWeight = myitem.text() new QSqlQuery( ) { cStr = "update weighthistory set f_date ='%f1' , f_time = '%f2' , "+ "f_weight ='%f3' where id = " + this.aIDs[nROW+1] cStr = substr(cStr,"%f1",cDate) cStr = substr(cStr,"%f2",cTime) cStr = substr(cStr,"%f3",cWeight) exec(cStr) delete() } ok The next screen shot for the application during the runtime 52.52. Weight History Application 502](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-525-2048.jpg)
![Ring Documentation, Release 1.4.1 52.53 Notepad Application In the next example we will see simple Notepad developed using the RingQt Load "guilib.ring" cActiveFileName = "" aTextColor = [0,0,0] aBackColor = [255,255,255] cFont = "MS Shell Dlg 2,14,-1,5,50,0,0,0,0,0" cWebsite = "http://www.google.com" 52.53. Notepad Application 503](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-526-2048.jpg)
![Ring Documentation, Release 1.4.1 } , new qpushbutton(win1) { setbtnimage(self,"image/search.png") setclickevent("pFind()") settooltip("Find and Replace") } , new qpushbutton(win1) { setbtnimage(self,"image/print.png") setclickevent("pPrint()") settooltip("Print") } , new qpushbutton(win1) { setbtnimage(self,"image/debug.png") setclickevent("pDebug()") settooltip("Debug (Run then wait!)") } , new qpushbutton(win1) { setbtnimage(self,"image/run.png") setclickevent("pRun()") settooltip("Run the program") } , new qpushbutton(win1) { setbtnimage(self,"image/close.png") setclickevent("pQuit()") settooltip("Quit") } ] tool1 = addtoolbar("files") { for x in aBtns addwidget(x) addseparator() next } menu1 = new qmenubar(win1) { sub1 = addmenu("File") sub2 = addmenu("Edit") sub3 = addmenu("View") sub4 = addmenu("Help") sub1 { oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+n")) setbtnimage(self,"image/new.png") settext("New") setclickevent("pNew()") } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+o")) setbtnimage(self,"image/open.png") settext("Open") setclickevent("pOpen()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+s")) setbtnimage(self,"image/save.png") settext("Save") setclickevent("pSave()") 52.53. Notepad Application 505](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-528-2048.jpg)
![Ring Documentation, Release 1.4.1 status1.showmessage("Cut!",0) func pCopy textedit1.copy() status1.showmessage("Copy!",0) func pPaste textedit1.paste() status1.showmessage("Paste!",0) func pFont oFontDialog = new qfontdialog() { aFont = getfont() } textedit1.selectall() cFont = aFont[1] pSetFont() Func pSetFont myfont = new qfont("",0,0,0) myfont.fromstring(cFont) textedit1.setcurrentfont(myfont) Func pColor new qcolordialog() { aTextColor = GetColor() } pSetColors() Func pColor2 new qcolordialog() { aBackColor = GetColor() } pSetColors() Func pSetColors textedit1.setstylesheet("color: rgb(" + aTextColor[1] + "," + aTextColor[2] + "," + aTextColor[3] + ");" + "background-color: rgb(" + aBackColor[1] + "," + aBackColor[2] + "," + aBackColor[3] + ")") func pOpen new qfiledialog(win1) { cName = getopenfilename(win1,"open file","c:","source files(*.ring)") if cName != NULL cActiveFileName = cName textedit1.settext(read(cActiveFileName)) ok } func pNew new qfiledialog(win1) { cName = getsavefilename(win1,"New file","","source files(*.ring)") if cName != NULL write(cName,"") cActiveFileName = cName textedit1.settext(read(cActiveFileName)) ok } Func WriteFile cFileName,cCode 52.53. Notepad Application 515](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-538-2048.jpg)
![Ring Documentation, Release 1.4.1 aCode = str2list(cCode) fp = fopen(cFileName,"wb") for cLine in aCode fwrite(fp,cLine+char(13)+char(10)) next fclose(fp) Func MsgBox cTitle,cMessage new qMessagebox(win1) { setwindowtitle(cTitle) setText(cMessage) show() } Func pLang MsgBox("Programming Language", "This application developed using the Ring programming language") Func pGUI MsgBox("GUI Library", "This application uses the Qt GUI Library through RingQt") Func pAbout MsgBox("About", "2016, Mahmoud Fayed <msfclipper@yahoo.com>") Func pSaveSettings cSettings = "aTextColor = ["+aTextColor[1]+","+aTextColor[2]+ ","+aTextColor[3]+"]" + nl + "aBackColor = ["+aBackColor[1]+","+aBackColor[2]+ ","+aBackColor[3]+"]" + nl + "cFont = '" + cFont + "'" + nl + "cWebSite = '" + cWebsite + "'" + nl cSettings = substr(cSettings,nl,char(13)+char(10)) write("ringnotepad.ini",cSettings) if lAsktoSave new qmessagebox(win1) { setwindowtitle("Save Changes?") settext("Some changes are not saved!") setInformativeText("Do you want to save your changes?") setstandardbuttons(QMessageBox_Yes | QMessageBox_No | QMessageBox_Cancel) result = exec() win1 { if result = QMessageBox_Yes pSave() but result = QMessageBox_Cancel return false ok } } ok return true Func pSetWebsite oWebView { loadpage(new qurl(cWebSite)) } 52.53. Notepad Application 516](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-539-2048.jpg)
![Ring Documentation, Release 1.4.1 Note: the functions pDebug(), pRun() and pRunNoConsole() in the previous sample are not portable! They are written in this sample for MS-Windows and we can update them for other operating systems. 52.54 The Cards Game In the next example we will see a simple Cards game developed using RingQt Each player get 5 cards, the cards are unknown to any one. each time one player click on one card to see it. if the card is identical to another card the play get point for each card. if the card value is “5” the player get points for all visible cards. Load "guilib.ring" nScale = 1 app1 = new qApp mypic = new QPixmap("cards.jpg") mypic2 = mypic.copy(0,(124*4)+1,79,124) Player1EatPic = mypic.copy(80,(124*4)+1,79,124) Player2EatPic= mypic.copy(160,(124*4)+1,79,124) aMyCards = [] aMyValues = [] for x1 = 0 to 3 for y1 = 0 to 12 temppic = mypic.copy((79*y1)+1,(124*x1)+1,79,124) aMyCards + temppic aMyValues + (y1+1) next next 52.54. The Cards Game 518](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-541-2048.jpg)
![Ring Documentation, Release 1.4.1 aCards = aMyCards aValues = aMyValues layout2 = new qhboxlayout() aBtns = [] for x = 1 to nCardsCount aBtns + new qpushbutton(win1) aBtns[x].setfixedwidth(79*nScale) aBtns[x].setfixedheight(124*nScale) gui_setbtnpixmap(aBtns[x],mypic2) layout2.addwidget(aBtns[x]) aBtns[x].setclickevent("Page1.Player1click("+x+")") next layout1.addwidget(label1) layout1.addlayout(layout2) label2 = new qlabel(win1) { settext("Player (2) - Score : " + nPlayer2Score) setalignment(Qt_AlignHCenter | Qt_AlignVCenter) setstylesheet("color: white; background-color: red; font-size:20pt") setfixedheight(200) } layout3 = new qhboxlayout() aBtns2 = [] for x = 1 to nCardsCount aBtns2 + new qpushbutton(win1) aBtns2[x].setfixedwidth(79*nScale) aBtns2[x].setfixedheight(124*nScale) gui_setbtnpixmap(aBtns2[x],mypic2) layout3.addwidget(aBtns2[x]) aBtns2[x].setclickevent("Page1.Player2click("+x+")") next layout1.addwidget(label2) layout1.addlayout(layout3) layout1.addwidget(closebtn) win1.setlayout(layout1) app1.exec() Func Player1Click x if nRole = 1 and aStatus[x] = 0 nPos = ((random(100)+clock())%(len(aCards)-1)) + 1 gui_setbtnpixmap(aBtns[x],aCards[nPos]) del(aCards,nPos) nRole = 2 aStatus[x] = 1 aStatusValues[x] = aValues[nPos] del(aValues,nPos) Player1Eat(x,aStatusValues[x]) checknewgame() 52.54. The Cards Game 520](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-543-2048.jpg)
![Ring Documentation, Release 1.4.1 ok Func Player2Click x if nRole = 2 and aStatus2[x] = 0 nPos = ((random(100)+clock())%(len(aCards)-1)) + 1 gui_setbtnpixmap(aBtns2[x],aCards[nPos]) del(aCards,nPos) nRole = 1 aStatus2[x] = 1 aStatusValues2[x] = aValues[nPos] del(aValues,nPos) Player2Eat(x,aStatusValues2[x]) checknewgame() ok Func Player1Eat nPos,nValue app1.processEvents() delay(nDelayEat) lEat = false for x = 1 to nCardsCount if aStatus2[x] = 1 and (aStatusValues2[x] = nValue or nValue=5) aStatus2[x] = 2 gui_setbtnpixmap(aBtns2[x],Player1EatPic) lEat = True nPlayer1Score++ ok if (x != nPos) and (aStatus[x] = 1) and (aStatusValues[x] = nValue or nValue=5) aStatus[x] = 2 gui_setbtnpixmap(aBtns[x],Player1EatPic) lEat = True nPlayer1Score++ ok next if lEat nPlayer1Score++ gui_setbtnpixmap(aBtns[nPos],Player1EatPic) aStatus[nPos] = 2 label1.settext("Player (1) - Score : " + nPlayer1Score) ok Func Player2Eat nPos,nValue app1.processEvents() delay(nDelayEat) lEat = false for x = 1 to nCardsCount if aStatus[x] = 1 and (aStatusValues[x] = nValue or nValue = 5) aStatus[x] = 2 gui_setbtnpixmap(aBtns[x],Player2EatPic) lEat = True nPlayer2Score++ ok if (x != nPos) and (aStatus2[x] = 1) and 52.54. The Cards Game 521](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-544-2048.jpg)
![Ring Documentation, Release 1.4.1 (aStatusValues2[x] = nValue or nValue=5 ) aStatus2[x] = 2 gui_setbtnpixmap(aBtns2[x],Player2EatPic) lEat = True nPlayer2Score++ ok next if lEat nPlayer2Score++ gui_setbtnpixmap(aBtns2[nPos],Player2EatPic) aStatus2[nPos] = 2 label2.settext("Player (2) - Score : " + nPlayer2Score) ok Func checknewgame if isnewgame() lnewgame = true if nPlayer1Score > nPlayer2Score label1.settext("Player (1) Wins!!!") ok if nPlayer2Score > nPlayer1Score label2.settext("Player (2) Wins!!!") ok app1.processEvents() delay(nDelayNewGame) win1.delete() app1.quit() ok Func isnewgame for t in aStatus if t = 0 return false ok next for t in aStatus2 if t = 0 return false ok next return true Func delay x nTime = x * 1000 oTest = new qTest oTest.qsleep(nTime) The application during the runtime 52.54. The Cards Game 522](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-545-2048.jpg)
![Ring Documentation, Release 1.4.1 show() } Func Increment label1 { setText( "" + ( 0 + text() + 1 ) ) } Class SecondWindow win = new qWidget() { setgeometry(400,50,300,200) setWindowTitle("Second Window") label1 = new qLabel(win) { setgeometry(10,10,300,30) setText("0") } btn1 = new qPushButton(win) { move(100,100) setText("Decrement") setClickEvent($ObjectName+".decrement()") } show() } Func Decrement label1 { setText( "" + ( 0 + text() - 1 ) ) } 56.12 Conflict between self inside braces and self in the class region In the class region (after the class name and before any methods) we define the attributes. In this region we have access to the global scope and the local scope will point to the object scope. Three Scopes • Global Scope —> Gloabl Scope • Object Scope —> Object Scope • Local Scope —> Object Scope Look at this example New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] aFriends + new Friend { name = "Gal" 56.12. Conflict between self inside braces and self in the class region 555](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-578-2048.jpg)
![Ring Documentation, Release 1.4.1 } aFriends + new Friend { name = "Bert" } Class Friend name Output: name: NULL name: NULL The problem in the previous example is that the Class account contains an attribute called “name” and the Friend class contains an attribue called “name” also. If you tried using self.name inside braces you will get the same result! New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] aFriends + new Friend { self.name = "Gal" } aFriends + new Friend { self.name = "Bert" } Class Friend name So why using self.name inside braces doesn’t solve this conflict? Because after the class region we have • global scope —> global scope • object scope —> object scope (Account Class) • local scope —> local scope (Account Class) When we use braces we change the object scope, so we have • global scope —> global scope • object scope —> object scope (Friend Class) • local scope —> local scope (Account Class) Ring search in the local scope first, so using self.name will use the Account class. There are many solution Solution (1) : Access the object through the list New Account { see aFriends } Class Account 56.12. Conflict between self inside braces and self in the class region 556](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-579-2048.jpg)
![Ring Documentation, Release 1.4.1 name = "Mahmoud" aFriends = [] aFriends + new Friend aFriends[len(aFriends)] { aFriends[len(aFriends)].name = "Gal" } aFriends + new Friend aFriends[len(aFriends)] { aFriends[len(aFriends)].name = "Bert" } Class Friend name Solution (2) : Create Method in the friend class to set the name attribute. New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] aFriends + new Friend { setname("Gal") } aFriends + new Friend { setname("Bert") } Class Friend name func setname cName name = cName Solution (3) : Create a method in the account class to set the attribute New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] friend("Gal") friend("Bert") func friend cName aFriends + new Friend { name = cName } Class Friend name Solution (4) : Declarative Programming New Account { name = "mahmoud" friend { 56.12. Conflict between self inside braces and self in the class region 557](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-580-2048.jpg)
![Ring Documentation, Release 1.4.1 name = "Gal" } friend { name = "Bert" } see aFriends } Class Account name aFriends = [] friend func getfriend aFriends + new Friend return aFriends[len(aFriends)] Class Friend name Output: name: Gal name: Bert 56.13 Using braces to escape from the current object scope Since braces change the current object scope to another object. we can use it to do some work without modifying the class attributes and using the same variable names. new point {x=10 y=20 z=30 start() } class point x y z func start see self # print the x y z values (10,20,30) new Local { x = 100 y = 200 z = 300 } see self # print the x y z values (10,20,30) see x + nl # will print 100 see y + nl # will print 200 see z + nl # will print 300 Self { # NO Advantage - Search is done in local scope first see x + nl # will print 100 see y + nl # will print 200 see z + nl # will print 300 } see self.x + nl # will print 10 see self.y + nl # will print 20 see self.z + nl # will print 30 class Local Output: x: 10.000000 y: 20.000000 56.13. Using braces to escape from the current object scope 558](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-581-2048.jpg)
![Ring Documentation, Release 1.4.1 EndLine =================================================== 60.2 Printing Rules Command: ring test.ring -rules -norun Output: =================================================== Grammar Rules Used by The Parser =================================================== Rule : Program --> {Statement} Line 1 Rule : Statement --> 'Func' Identifier [ParaList] Line 2 Rule : Factor --> Literal Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Arithmetic --> Arithmetic + Arithmetic Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 3 Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic 60.2. Printing Rules 578](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-601-2048.jpg)
![Ring Documentation, Release 1.4.1 Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'For' Identifier '=' Expr to Expr ['step' Expr] Line 4 Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Arithmetic --> Arithmetic + Arithmetic Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 5 Rule : Next --> 'Next' Line 6 Rule : Mixer -> '(' [Expr { ',' Expr} ] ')' Line 8 Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Statement --> 'Func' Identifier [ParaList] Line 9 Rule : Factor --> Literal Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Arithmetic --> Arithmetic + Arithmetic 60.2. Printing Rules 579](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-602-2048.jpg)
![Ring Documentation, Release 1.4.1 Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 10 Rule : Factor --> New Identifier {'.' Identifier } Rule : Mixer --> '{' {Statement} BraceEnd Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot 60.2. Printing Rules 580](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-603-2048.jpg)
![Ring Documentation, Release 1.4.1 Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : BraceEnd --> '}' Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Line 11 Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift 60.2. Printing Rules 581](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-604-2048.jpg)
![Ring Documentation, Release 1.4.1 Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 13 Rule : Statement --> 'Class' Identifier Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr =================================================== 60.3 Printing Intermediate Code Command: ring test.ring -ic -norun Output: 60.3. Printing Intermediate Code 582](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-605-2048.jpg)
![CHAPTER SIXTYONE LOW LEVEL FUNCTIONS In this chapter we will learn about the low level functions provided by Ring • callgc() • varptr() • space() • nullpointer() • object2pointer() • pointer2object() • ptrcmp() • ringvm_cfunctionslist() • ringvm_functionslist() • ringvm_classeslist() • ringvm_packageslist() • ringvm_memorylist() • ringvm_calllist() • ringvm_fileslist() 61.1 callgc() function Use this function to force calling the garbage collector during function execution when you use a loop that create temp. variables that you don’t free using the assignment operation. It’s very rare to need this function but it’s useful when you create something like event-loop for your game engine and start creating lists on the fly when you call functions. Example While True # process events # call functions using temp. lists like myfunc(["temp list"]) # call the garbage collector callgc() End 591](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-614-2048.jpg)
![Ring Documentation, Release 1.4.1 sysargv 3 B:ringbin/ring B:/ring/tests/scripts/memorylist.ring 0 0 x 2 10 0 0 y 2 20 0 0 61.13 ringvm_calllist() function The Function return a list of the functions call list. Each List Member is a list contains the next items • Function Type • Function Name • Program Counter (PC) • Stack Pointer (SP) • Temp. Memory List • Method or Function Flag • Caller PC • FuncExec Flag • ListStart Flag • Nested Lists Pointer • State List Syntax: RingVM_CallList() ---> List Example: hello() func hello test() func test mylist = ringvm_calllist() for t in mylist see t[2] + nl next Output: 61.13. ringvm_calllist() function 599](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-622-2048.jpg)
![CHAPTER SIXTYTWO INTRODUCTION In this chapter we will learn about embedding Ring in Ring programs and applications. 62.1 Embedding Ring in Ring without sharing the State From Ring 1.0 we already have functions for embedding Ring in the C language. Also we can execute Ring code inside Ring programs using the eval() function. In this release we provide functions for embedding Ring in Ring programs without sharing the state. Advantages: 1. Quick integration for Ring programs and applications together without conflicts. 2. Execute and run Ring code in safe environments that we can trace. Example: pState = ring_state_init() ring_state_runcode(pState,"See 'Hello, World!'+nl") ring_state_runcode(pState,"x = 10") pState2 = ring_state_init() ring_state_runcode(pState2,"See 'Hello, World!'+nl") ring_state_runcode(pState2,"x = 20") ring_state_runcode(pState,"see x +nl") ring_state_runcode(pState2,"see x +nl") v1 = ring_state_findvar(pState,"x") v2 = ring_state_findvar(pState2,"x") see v1[3] + nl see V2[3] + nl ring_state_delete(pState) ring_state_delete(pState2) Output: Hello, World! Hello, World! 10 20 10 20 601](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-624-2048.jpg)
![CHAPTER SIXTYFOUR EMBEDDING RING LANGUAGE IN C/C++ PROGRAMS We can use the Ring language from C/C++ programs using the next functions RingState *ring_state_init(); ring_state_runcode(RingState *pState,const char *cCode); ring_state_delete(RingState *pState); 64.1 Ring State The idea is to use the ring_state_init() to create new state for the Ring Language then call the ring_state_runcode() function to execut Ring code using the same state. When we are done, we call the ring_state_delete() to free the memory. Example: #include "ring.h" #include "stdlib.h" int main(int argc, char *argv[]) { RingState *pState = ring_state_init(); printf("welcomen"); ring_state_runcode(pState,"see 'hello world from the ring programming language'+nl"); ring_state_delete(pState); } Output: welcome hello world from the ring programming language 64.2 Ring State Functions The Ring API comes with the next functions to create and delete the state. Also we have functions to create new variables and get variables values. RingState * ring_state_init ( void ) ; RingState * ring_state_delete ( RingState *pRingState ) ; void ring_state_runcode ( RingState *pRingState,const char *cStr ) ; List * ring_state_findvar ( RingState *pRingState,const char *cStr ) ; List * ring_state_newvar ( RingState *pRingState,const char *cStr ) ; void ring_state_main ( int argc, char *argv[] ) ; 613](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-636-2048.jpg)
![Ring Documentation, Release 1.4.1 void ring_state_runfile ( RingState *pRingState,const char *cFileName ) ; void ring_state_runobjectfile ( RingState *pRingState,const char *cFileName ) ; 64.3 Ring State Variables We can create more than one ring state in the same program and we can create and modify variable values. To get the variable list we can use the ring_state_findvar() function. To create new variable we can use the ring_state_newvar() function. Example: #include "ring.h" #include "stdlib.h" int main(int argc, char *argv[]) { List *pList; RingState *pState = ring_state_init(); RingState *pState2 = ring_state_init(); printf("welcomen"); ring_state_runcode(pState,"see 'hello world from the ring programming language'+nl"); printf("Again from C we will call ring coden"); ring_state_runcode(pState,"for x = 1 to 10 see x + nl next"); ring_state_runcode(pState2,"for x = 1 to 5 see x + nl next"); printf("Now we will display the x variable value from ring coden"); ring_state_runcode(pState,"see 'x value : ' + x + nl "); ring_state_runcode(pState2,"see 'x value : ' + x + nl "); pList = ring_state_findvar(pState,"x"); printf("Printing Ring variable value from C , %.0fn", ring_list_getdouble(pList,RING_VAR_VALUE)); printf("now we will set the ring variable value from Cn"); ring_list_setdouble(pList,RING_VAR_VALUE,20); ring_state_runcode(pState,"see 'x value after update : ' + x + nl "); pList = ring_state_newvar(pState,"v1"); ring_list_setdouble(pList,RING_VAR_VALUE,10); pList = ring_state_newvar(pState,"v2"); ring_list_setdouble(pList,RING_VAR_VALUE,20); ring_state_runcode(pState,"see 'v1 + v2 = ' see v1+v2 see nl"); ring_state_runcode(pState,"see 'end of test' + nl"); ring_state_delete(pState); 64.3. Ring State Variables 614](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-637-2048.jpg)
![Ring Documentation, Release 1.4.1 #include <QDialog> #include <QTextCursor> #include <QTextBlock> #include <QTextDocumentFragment> #include <QColorDialog> #include <QHeaderView> #include <QStringList> #include <QKeySequence> #include <QLCDNumber> #include <QInputDialog> #include <QDesktopWidget> #include <QRect> #include <QTextDocument> extern "C" { #define RING_DLL __declspec(dllexport) RING_DLL void ringlib_init(RingState *pRingState) { new QApplication(pRingState->argc,pRingState->argv); ring_qt_start(pRingState) ; } } </code> <runcode> aStringTypes + "QString" aBeforeReturn + ["QString",".toStdString().c_str()"] aNewMethodName + ["QWebView","load","loadpage"] aNewMethodName + ["QMediaPlaylist","load","loadfile"] aNewMethodName + ["QMediaPlaylist","next","movenext"] aNewMethodName + ["QPainter","end","endpaint"] aNewMethodName + ["QPicture","load","loadfile"] aNewMethodName + ["QLineEdit","end","endtext"] aNewMethodName + ["QDialog","done","donedialog"] aNewMethodName + ["QTextDocument","end","enddoc"] aNewMethodName + ["QTextBlock","next","nextblock"] </runcode> <class> name: qApp nonew </class> <register> void exec(void) void quit(void) void processEvents(void) </register> <code> RING_FUNC(ring_qApp_quit) { 65.18. Configuration file for the Qt Framework 627](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-650-2048.jpg)
![Ring Documentation, Release 1.4.1 • CURLFORMcode curl_formadd_6(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, const char *,CURLformoption, void * , CURLformoption, long , CURLformoption) • CURLFORMcode curl_formadd_7(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, struct curl_forms [], CURLformoption) • void curl_formfree(struct curl_httppost * form) • CURLLIST *curl_slist_append(CURLLIST * list, const char * string ) • void curl_slist_free_all(CURLLIST * list) • char *curl_easy_escape( CURL * curl , const char * string , int length ) • char *curl_easy_unescape( CURL * curl , const char * url , int inlength , int * outlength ) 636](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-659-2048.jpg)
![Ring Documentation, Release 1.4.1 • void al_get_new_window_position(int *x, int *y) • void al_set_new_window_position(int x, int y) • int al_get_new_display_refresh_rate(void) • void al_set_new_display_refresh_rate(int refresh_rate) • ALLEGRO_EVENT_SOURCE *al_get_display_event_source(ALLEGRO_DISPLAY *display) • ALLEGRO_BITMAP *al_get_backbuffer(ALLEGRO_DISPLAY *display) • void al_flip_display(void) • void al_update_display_region(int x, int y, int width, int height) • bool al_wait_for_vsync(void) • int al_get_display_width(ALLEGRO_DISPLAY *display) • int al_get_display_height(ALLEGRO_DISPLAY *display) • bool al_resize_display(ALLEGRO_DISPLAY *display, int width, int height) • bool al_acknowledge_resize(ALLEGRO_DISPLAY *display) • void al_get_window_position(ALLEGRO_DISPLAY *display, int *x, int *y) • void al_set_window_position(ALLEGRO_DISPLAY *display, int x, int y) • int al_get_display_flags(ALLEGRO_DISPLAY *display) • bool al_set_display_flag(ALLEGRO_DISPLAY *display, int flag, bool onoff) • int al_get_display_option(ALLEGRO_DISPLAY *display, int option) • int al_get_display_format(ALLEGRO_DISPLAY *display) • int al_get_display_refresh_rate(ALLEGRO_DISPLAY *display) • void al_set_window_title(ALLEGRO_DISPLAY *display, const char *title) • void al_set_display_icon(ALLEGRO_DISPLAY *display, ALLEGRO_BITMAP *icon) • void al_set_display_icons(ALLEGRO_DISPLAY *display,int num_icons, ALLEGRO_BITMAP *icons[]) • bool al_inhibit_screensaver(bool inhibit) • void al_acknowledge_drawing_halt(ALLEGRO_DISPLAY *display) • void al_acknowledge_drawing_resume(ALLEGRO_DISPLAY *display) • int al_get_display_orientation(ALLEGRO_DISPLAY* display) • void al_set_display_option(ALLEGRO_DISPLAY *display, int option, int value) • bool al_get_window_constraints(ALLEGRO_DISPLAY *display,int *min_w, int *min_h, int *max_w, int *max_h) • bool al_set_window_constraints(ALLEGRO_DISPLAY *display,int min_w, int min_h, int max_w, int max_h) • ALLEGRO_EVENT_QUEUE *al_create_event_queue(void) • void al_destroy_event_queue(ALLEGRO_EVENT_QUEUE *queue) • void al_register_event_source(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT_SOURCE *source) • void al_unregister_event_source(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT_SOURCE *source) • bool al_is_event_queue_empty(ALLEGRO_EVENT_QUEUE *queue) 639](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-662-2048.jpg)
![Ring Documentation, Release 1.4.1 • ALLEGRO_USTR *al_ustr_new_from_utf16(uint16_t const *s) • size_t al_ustr_size_utf16(const ALLEGRO_USTR *us) • size_t al_ustr_encode_utf16(const ALLEGRO_USTR *us, uint16_t *s,size_t n) • size_t al_utf8_width(int c) • size_t al_utf8_encode(char s[], int32_t c) • size_t al_utf16_width(int c) • LPDIRECT3DDEVICE9 al_get_d3d_device(ALLEGRO_DISPLAY *display) • LPDIRECT3DTEXTURE9 al_get_d3d_system_texture(ALLEGRO_BITMAP *bitmap) • LPDIRECT3DTEXTURE9 al_get_d3d_video_texture(ALLEGRO_BITMAP *bitmap) • bool al_have_d3d_non_pow2_texture_support(void) • bool al_have_d3d_non_square_texture_support(void) • void al_get_d3d_texture_position(ALLEGRO_BITMAP *bitmap, int *u, int *v) • bool al_is_d3d_device_lost(ALLEGRO_DISPLAY *display) • ALLEGRO_OGL_EXT_LIST *al_get_opengl_extension_list(void) • void *al_get_opengl_proc_address(const char *name) • GLuint al_get_opengl_texture(ALLEGRO_BITMAP *bitmap) • void al_get_opengl_texture_size(ALLEGRO_BITMAP *bitmap, int *w, int *h) • void al_get_opengl_texture_position(ALLEGRO_BITMAP *bitmap, int *u, int *v) • GLuint al_get_opengl_fbo(ALLEGRO_BITMAP *bitmap) • void al_remove_opengl_fbo(ALLEGRO_BITMAP *bitmap) • bool al_have_opengl_extension(const char *extension); • uint32_t al_get_opengl_version(void) • int al_get_opengl_variant(void) • void al_set_current_opengl_context(ALLEGRO_DISPLAY *display) • bool al_install_audio(void) • void al_uninstall_audio(void) • bool al_is_audio_installed(void) • bool al_reserve_samples(int reserve_samples) • uint32_t al_get_allegro_audio_version(void) • size_t al_get_audio_depth_size(ALLEGRO_AUDIO_DEPTH depth) • size_t al_get_channel_count(ALLEGRO_CHANNEL_CONF conf) • ALLEGRO_VOICE *al_create_voice(unsigned int freq,ALLEGRO_AUDIO_DEPTH depth, ALLE- GRO_CHANNEL_CONF chan_conf) • void al_destroy_voice(ALLEGRO_VOICE *voice) • void al_detach_voice(ALLEGRO_VOICE *voice) • bool al_attach_audio_stream_to_voice(ALLEGRO_AUDIO_STREAM *stream,ALLEGRO_VOICE *voice) 650](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-673-2048.jpg)
![Ring Documentation, Release 1.4.1 • void al_get_text_dimensions(const ALLEGRO_FONT *f,char const *text,int *bbx, int *bby, int *bbw, int *bbh) • void al_get_ustr_dimensions(const ALLEGRO_FONT *f,ALLEGRO_USTR const *ustr,int *bbx, int *bby, int *bbw, int *bbh) • uint32_t al_get_allegro_font_version(void) • ALLEGRO_FONT *al_grab_font_from_bitmap(ALLEGRO_BITMAP *bmp,int ranges_n, const int ranges[]) • ALLEGRO_FONT *al_load_bitmap_font(const char *fname) • ALLEGRO_FONT *al_create_builtin_font(void) • bool al_init_ttf_addon(void) • void al_shutdown_ttf_addon(void) • ALLEGRO_FONT *al_load_ttf_font(char const *filename, int size, int flags) • ALLEGRO_FONT *al_load_ttf_font_f(ALLEGRO_FILE *file,char const *filename, int size, int flags) • ALLEGRO_FONT *al_load_ttf_font_stretch(char const *filename, int w, int h,int flags) • ALLEGRO_FONT *al_load_ttf_font_stretch_f(ALLEGRO_FILE *file,char const *filename, int w, int h, int flags) • uint32_t al_get_allegro_ttf_version(void) • bool al_init_image_addon(void) • void al_shutdown_image_addon(void) • uint32_t al_get_allegro_image_version(void) • ALLEGRO_FILE *al_open_memfile(void *mem, int64_t size, const char *mode) • uint32_t al_get_allegro_memfile_version(void) • bool al_init_native_dialog_addon(void) • void al_shutdown_native_dialog_addon(void) • ALLEGRO_FILECHOOSER *al_create_native_file_dialog(char const *initial_path,char const *title,char const *patterns,int mode) • bool al_show_native_file_dialog(ALLEGRO_DISPLAY *display,ALLEGRO_FILECHOOSER *dialog) • int al_get_native_file_dialog_count(const ALLEGRO_FILECHOOSER *dialog) • const char *al_get_native_file_dialog_path(const ALLEGRO_FILECHOOSER *dialog, size_t i) • void al_destroy_native_file_dialog(ALLEGRO_FILECHOOSER *dialog) • int al_show_native_message_box(ALLEGRO_DISPLAY *display,char const *title, char const *heading, char const *text,char const *buttons, int flags) • ALLEGRO_TEXTLOG *al_open_native_text_log(char const *title, int flags) • void al_close_native_text_log(ALLEGRO_TEXTLOG *textlog) • uint32_t al_get_allegro_native_dialog_version(void) • void al_set_physfs_file_interface(void) • uint32_t al_get_allegro_physfs_version(void) • uint32_t al_get_allegro_primitives_version(void) • bool al_init_primitives_addon(void) 655](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-678-2048.jpg)
![Ring Documentation, Release 1.4.1 Output 1 2 3 4 5 X value = 10 71.18 Why the list index start from 1 in Ring? It’s about how we count in the real world, when we have three apples in our hand we say 1 2 3 We don’t start from 0 The question must be why the other languages start from 0 ? The answer is, because this is related to the machine and how we deal with values and memory address. Example we have array called myarray[5] In memory : myarray will have an address The first item will be stored in that address The second item will come after that address and so on Now when we need to point to the first item we need the address of myarray So we type myarray[0] because myarray + 0 result will still point to the first item for the second item myarray[1] because myarray + 1 result will point to the second item and so on In Low Level languages or languages near to the machine it’s good to be like this But for high level language designed for applications it’s better to be natural Example mylist = [1,2,3,4,5] for x = 1 to len(mylist) see x + nl next In the previous example we start from 1 to the length of the array if the index starts from 0 we will write for x = 0 to len(mylist)-1 or remember the for loop in other languages for(x=0 ; x<nMax ; x++ ) You will use the < operator ! 71.19 Is there constructor methods in Ring? When you create new object for example 71.18. Why the list index start from 1 in Ring? 818](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-841-2048.jpg)
![Ring Documentation, Release 1.4.1 Add Ring/bin folder to the path then 71.25 How to get the file size using ftell() and fseek() functions? The next function can be used to get the file size without reading the file! func getFileSize fp C_FILESTART = 0 C_FILEEND = 2 fseek(fp,0,C_FILEEND) nFileSize = ftell(fp) fseek(fp,0,C_FILESTART) return nFileSize Note: The previous function take the fp (file pointer) as parameter, We can get the fp from opening the file using fopen() function. fp = fopen("filename","r") see "File Size : " + getFileSize(fp) + nl Another solution (Read the file) see len(read("filename")) 71.26 How to get the current source file path? We can use the next function to get the current source file path then we can add the path variable to the file name cPath = CurrentPath() func currentpath cFileName = filename() for x = len(cFileName) to 1 step -1 if cFileName[x] = "/" return left(cFileName,x-1) ok next return cFileName 71.27 What about predefined parameters or optional parameters in functions? if you want to use predefined parameters or optional parameters Just accept a list that works like hash/dictionary Example sum([ :a = 1, :b = 2]) sum([ :a = 1 ]) sum([ :b = 2 ]) func sum pList if plist[:a] = NULL pList[:a] = 4 ok 71.25. How to get the file size using ftell() and fseek() functions? 823](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-846-2048.jpg)
![Ring Documentation, Release 1.4.1 if plist[:b] = NULL pList[:b] = 5 ok see pList[:a] + pList[:b] + nl Output 3 6 6 71.28 How to print keys or values only in List/Dictionary? If you want to print keys only or values only just select the index of the item (one or two). Example C_COUNTRY = 1 C_CITY = 2 mylist = [ :KSA = "Riyadh" , :Egypt = "Cairo" ] for x in mylist see x[C_COUNTRY] + nl next for x in mylist see x[C_CITY] + nl next Output ksa egypt Riyadh Cairo 71.29 Why I get a strange result when printing nl with lists? In the next code list = 1:5 # list = [1,2,3,4,5] see list + nl New Line will be added to the list then the list will be printed, the default print of the lists will print a newline at the end, You added new newline and You have now 2 newlines to be printed. See <Expr> The see command just print the final result of the expression, the expression will be evaluated as it nl = char(13) + char(10) # just a variable that you can change to anything ! The + is an operator 71.28. How to print keys or values only in List/Dictionary? 824](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-847-2048.jpg)
![Ring Documentation, Release 1.4.1 Sorry, We can't use x! Now we will talk about NULL and ISNULL() Since we get error message when we deal with uninitialized variables We can check these errors using Try/Catch/Done, So we uses NULL and ISNULL() for dealing with Strings. NULL is a variable contains an empty string ISNULL() is a function that returns true (1) if the input is an empty string or just a string contains “NULL” This because we need to test these values (empty strings) and strings contains “NULL” that sometimes come from external resource like DBMS. Example See IsNull(5) + nl + # print 0 IsNull("hello") + nl + # print 0 IsNull([1,3,5]) + nl + # print 0 IsNull("") + nl + # print 1 IsNull("NULL") # print 1 71.34 How to print lists that contains objects? In this example we will see how we can print a list contains objects. aList = [[1,2,3] , new point(1,2,3), new point(1,2,3)] see "print the list" + nl see alist see "print the item (object)" + nl see alist[2] class point x y z func init p1,p2,p3 x=p1 y=p2 z=p3 Output print the list 1 2 3 x: 1.000000 y: 2.000000 z: 3.000000 x: 1.000000 y: 2.000000 z: 3.000000 print the item (object) x: 1.000000 y: 2.000000 z: 3.000000 71.35 How to insert an item to the first position in the list? To insert an item we can use the insert(aList,nIndex,Value) function. 71.34. How to print lists that contains objects? 828](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-851-2048.jpg)
![Ring Documentation, Release 1.4.1 button = [btn1, btn2] show() } exec() } func click button[1] { settext ("Button3") } button[2] { settext ("Button4") } 71.40 How to Close a window then displaying another one? This example demonstrates how to close a window and show another one Load "guilib.ring" app=new qApp { frmBefore=new Qwidget() { setWindowTitle("before!") resize(300,320) move(200,200) button=new qPushButton(frmBefore) { setText("Close") setClickEvent("frmBefore.close() frmMain.show()") } show() } frmMain=new Qwidget() { setWindowTitle("After!") resize(300,320) move(200,200) } exec() } 71.41 How to create a Modal Window? This example demonstrates how to create a modal window load "guilib.ring" app=new qApp { 71.40. How to Close a window then displaying another one? 831](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-854-2048.jpg)
![Ring Documentation, Release 1.4.1 if your work is special (to specific application) just put it in another extension. 71.49 How to add Combobox and other elements to the cells of a QTableWidget? Check the next code Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,1100,370) setwindowtitle("Using QTableWidget") Table1 = new qTableWidget(win1) { setrowcount(10) setcolumncount(10) setGeometry(0,0,800,400) setselectionbehavior(QAbstractItemView_SelectRows) for x = 1 to 10 for y = 1 to 10 item1 = new qtablewidgetitem("R"+X+"C"+Y) setitem(x-1,y-1, item1) next next cmb = new QComboBox(Table1) { alist = ["one","two","three","four","five"] for x in aList additem(x,0) next } setCellWidget(5, 5, cmb) } setcentralwidget(table1) show() } exec() } 71.50 How to perform some manipulations on selected cells in QTableWidget? Check the next sample Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,800,600) setwindowtitle("Using QTableWidget") Table1 = new qTableWidget(win1) { setrowcount(10) setcolumncount(10) setGeometry(10,10,400,400) 71.49. How to add Combobox and other elements to the cells of a QTableWidget? 839](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-862-2048.jpg)
![Ring Documentation, Release 1.4.1 • Error (C4) : Unclosed control strucutre, ‘end’ is missing • Error (C5) : Unclosed control strucutre, next is missing • Error (C6) : Error in function name • Error (C7) : Error in list items • Error (C8) : Parentheses ‘)’ is missing • Error (C9) : Brackets ‘]’ is missing • Error (C10) : Error in parent class name • Error (C11) : Error in expression operator • Error (C12) :No class definition • Error (C13) : Error in variable name • Error (C14) : Try/Catch miss the Catch keyword! • Error (C15) : Try/Catch miss the Done keyword! • Error (C16) : Error in Switch statement expression! • Error (C17) : Switch statement without OFF • Error (C18) : Missing closing brace for the block opened! • Error (C19) : Numeric Overflow! • Error (C20) : Error in package name • Error (C21) : Unclosed control strucutre, ‘again’ is missing • Error (C22) : Function redefinition, function is already defined! • Error (C23) : Using ‘(‘ after number! • Error (C24) : The parent class name is identical to the subclass name • Error (C25) : Trying to access the self reference after the object name” 72.4 Runtime Errors • Error (R1) : Cann’t divide by zero ! • Error (R2) : Array Access (Index out of range) ! • Error (R3) : Calling Function without definition ! • Error (R4) : Stack Overflow ! • Error (R5) : Can’t access the list item, Object is not list ! • Error (R6) : Variable is required • Error (R7) : Can’t assign to a string letter more than one character • Error (R8) : Variable is not a string • Error (R9) : Using exit command outside loops • Error (R10) : Using exit command with number outside the range • Error (R11) : error in class name, class not found! 72.4. Runtime Errors 844](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-867-2048.jpg)
![Ring Documentation, Release 1.4.1 • Error (R12) : error in property name, property not found! • Error (R13) : Object is required • Error (R14) : Calling Method without definition ! • Error (R15) : error in parent class name, class not found! • Error (R16) : Using braces to access unknown object ! • Error (R17) : error, using ‘Super’ without parent class! • Error (R18) : Numeric Overflow! • Error (R19) : Calling function with less number of parameters! • Error (R20) : Calling function with extra number of parameters! • Error (R21) : Using operator with values of incorrect type • Error (R22) : Using loop command outside loops • Error (R23) : Using loop command with number outside the range • Error (R24) : Using uninitialized variable • Error (R25) : Error in package name, Package not found! • Error (R26) : Calling private method from outside the class • Error (R27) : Using private attribute from outside the class • Error (R28) : Using bad data type as step value • Error (R29) : Using bad data type in for loop • Error (R30) : parent class name is identical to child class name • Error (R31) : Trying to destory the object using the self reference • Error (R32) : The CALL command expect a variable contains string! • Error (R33) : Bad decimals number (correct range >= 0 and <=14) ! • Error (R34) : Variable is required for the assignment operation • Error (R35) : Can’t create/open the file! • Error (R36) : The column number is not correct! It’s greater than the number of columns in the list 72.5 Language Grammar Program —> {statement} Statement —> ‘package’ <Identifier> { ‘.’ <Identifier> } Statement —> ‘class’ <Identifier> [ ‘from’|’:’|’<’ <Identifier> ] Statement —> ‘func’|’def’ <Identifier> [ParaList] Statement —> ‘import’ <Identifier> { ‘.’ <Identifier> } Statement —> ‘private’ Statement —> ‘load’ <Literal> Statement —> ‘loadsyntax’ <Literal> 72.5. Language Grammar 845](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-868-2048.jpg)
![Ring Documentation, Release 1.4.1 Statement —> ‘changeringkeyword’ <OldKeyword> <NewKeyword> Statement —> ‘changeringoperator’ <OldOperator> <NewOperator> Statement —> ‘see’|’put’ <Expr> Statement —> ‘give’|’get’ <Identifier> Statement —> ‘if’ <Expr> [’{‘] {statement} [ {‘but’|’elseif’ <Expr> {Statement} } ] [’else’ {Statement} ] ‘ok’|’end’|’}’ Statement —> ‘Switch’ <Expr> [’{‘] { ‘on’|’case’ <Expr> {statement} } [’other’ {Statement} ] ‘off’|’end’|’}’ Statement —> ‘for’ <Identifier> ‘=’ <Expr> ‘to’ <Expr> [ ‘step’ <Expr> ] [’{‘] {Statement} ‘next’|’end’|’}’ Statement —> ‘for’ <Identifier> ‘in’ <Expr> [ ‘step’ <Expr> ] [’{‘] {statement} ‘next’|’end’|’}’ Statement —> ‘while’ <Expr> [’{‘] {statement} ‘end’|’}’ Statement —> ‘do’ {statement} ‘again’ <Expr> Statement —> ‘try’ {statement} [’{‘] ‘catch’ {statement} ‘done’|’end’|’}’ Statement —> ‘return’ <Expr> Statement —> ‘bye’ Statement —> ‘exit’ Statement —> ‘loop’ Statement —> <Expr> Statement —> epslion ParaList —> epslion ParaList —> [’(‘] <Identifier> [{ ‘,’ <Identifier> }] [’)’] Expr —> <LogicNot> [{ ‘and’|’or’ <LogicNot> }] LogicNot –> [’not’] <EqualOrNot> EqualOrNot –> [ ‘=’|’!=’ ] <Compare> Compare —> <BitOrXor> [ { ‘<’ | ‘>’ | ‘<=’ | ‘>=’ <BitOrXor> } ] BitOrXor —> <BitAnd> [ { ‘|’ | ‘^’ <BitAnd> } ] BitAnd —> <BitShift> [ { ‘&’ <BitShift> } ] BitShift —> <Arithmetic> [ { ‘<<’ | ‘>>’ <Arithmetic> } ] Arithmetic —> <Term> [ { ‘+’ | ‘-‘ <Term> } ] Term —> <Range> [ { ‘*’ | ‘/’ | ‘%’ <Range> } ] Range —> <Factor> [ ‘:’ <Factor> ] Factor —> <Identifier> [ {Mixer} ] [ ‘=’ <Expr> ] Factor —> <Number> Factor —> <Literal> Factor —> ‘:’ <Identifier> Factor —> ‘-‘ <Expr> Factor —> ‘(‘ <Expr> ‘)’ 72.5. Language Grammar 846](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-869-2048.jpg)
![Ring Documentation, Release 1.4.1 Factor —> <List> Factor —> ‘new’ <Identifier> Factor —> <AnonymousFunction> Factor —> ‘call’ <identifier> { ‘.’ <Identifier> } ‘(‘ <Parameters> ‘)’ List —> ‘[’ [ <Expr> { ‘,’ <Expr> } ] ‘]’ Mixer —> { ‘.’ <Identifier> } Mixer —> ‘[’ <Expr> ‘]’ Mixer —> ‘(‘ [ <Expr> [ { ‘,’ <Expr> }] ] ‘)’ Mixer —> ‘{‘ {Statement} ‘}’ AnonymousFunction —> ‘func’|’def’| [<ParaList>] ‘{‘ {Statement} ‘}’ 72.6 Virtual Machine (VM) Instructions Definitions :- • VM : Virtual Machine • Stack : VM Stack • IR : Instruction Register • PC : Program Counter • VP : Variable Pointer • Stack[nSize] : Last Item in the Stack (Last In - First Out) • VV : Variable Value (We have a Pointer to a variable, And we access this variable value) (Stack and Variables) 72.6. Virtual Machine (VM) Instructions 847](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-870-2048.jpg)
![Ring Documentation, Release 1.4.1 Operation Description • ICO_PUSHC Add string from the IR to the stack • ICO_PUSHN Add number from the IR to the stack • ICO_PUSHV Replace VP in the stack[nSize] with the variable value • ICO_LOADADDRESS Read variable name from the IR, push VP to the stack • ICO_ASSIGNMENT Stack[nSize-1] VV = Stack[nSize] VV , POP Stack[nSize] • ICO_INC Increment Number in Stack[nSize] by 1 • ICO_LOADAPUSHV The same as ICO_LOADADDRESS then ICO_PUSHV • ICO_NEWLINE Store new line number (debug info) • ICO_FREESTACK Remove all items from the stack , nSize = 0 • ICO_FILENAME Store the source code file name (debug info) • ICO_FREELOADASCOPE Free the Scope List of the current Expression (Jump) Operation Description • ICO_JUMP Set PC to new value from the IR • ICO_JUMPZERO If Stack[nSize] is a number = 0 then Set PC to new value from the IR • ICO_JUMPFOR End of for loop • ICO_JUMPONE If Stack[nSize] is a number = 1 then Set PC to new value from the IR • ICO_JUMPZERO2 As ICO_JUMPZERO but add 1 to the stack (required for many ‘AND’ conditions) • ICO_JUMPONE2 As ICO_JUMPONE but add 1 to the stack (required for many ‘OR’ conditions) (Compare) 72.6. Virtual Machine (VM) Instructions 848](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-871-2048.jpg)
![Ring Documentation, Release 1.4.1 Operation Description • ICO_LESSEQUAL If stack[nSize-1] <= stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_EQUAL If stack[nSize-1] = stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_LESS If stack[nSize-1] < stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_GREATER If stack[nSize-1] > stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_GREATEREQUAL If stack[nSize-1] >= stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_NOTEQUAL If stack[nSize-1] != stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 (Math) Operation Description • ICO_SUM Stack[nSize-1] = Stack[nSize-1] + Stack[nSize] , POP stack[nSize] • ICO_SUB Stack[nSize-1] = Stack[nSize-1] - Stack[nSize] , POP stack[nSize] • ICO_MUL Stack[nSize-1] = Stack[nSize-1] * Stack[nSize] , POP stack[nSize] • ICO_DIV Stack[nSize-1] = Stack[nSize-1] / Stack[nSize] , POP stack[nSize] • ICO_MOD Stack[nSize-1] = Stack[nSize-1] % Stack[nSize] , POP stack[nSize] • ICO_NEG Stack[nSize] = - Stack[nSize-1] • ICO_PLUSPLUS Stack[nSize] = Stack[nSize] + 1 • ICO_MINUSMINUS Stack[nSize] = Stack[nSize] - 1 (Logic) Operation Description • ICO_AND Stack[nSize-1] = Stack[nSize-1] && Stack[nSize] , POP stack[nSize] • ICO_OR Stack[nSize-1] = Stack[nSize-1] || Stack[nSize] , POP stack[nSize] • ICO_NOT Stack[nSize] = ! Stack[nSize] (Lists) 72.6. Virtual Machine (VM) Instructions 849](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-872-2048.jpg)
![Ring Documentation, Release 1.4.1 Operation Description • ICO_LISTSTART Start New List in Temp. Memory • ICO_LISTITEM Add List Item • ICO_LISTEND End List • ICO_LOADINDEXADDRESS Stack[nSize-1] = Stack[nSize-1] VV [ Stack[nSize] ] , POP stack[nSize] (Functions) Operation Description • ICO_LOADFUNC Find function • ICO_CALL Call function • ICO_RETURN Return from function • ICO_RETNULL Return NULl from function • ICO_RETFROMEVAL Return after eval() • ICO_RETITEMREF Return the list item reference - not the value • ICO_NEWFUNC Start new function • ICO_BLOCKFLAG Flag to determine where to jump later (after ICO_RETURN) • ICO_FUNCEXE Start executing function • ICO_ENDFUNCEXE End function execution • ICO_ANONYMOUS Anonymous function (User Interface) Operation Description • ICO_PRINT Print value to the standard output • ICO_GIVE Get input from the keyboard (End Program/Loop) 72.6. Virtual Machine (VM) Instructions 850](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-873-2048.jpg)
![Ring Documentation, Release 1.4.1 Operation Description • ICO_SETREFERENCE Copy by reference • ICO_KILLREFERENCE Remove reference • ICO_ASSIGNMENTPOINTER Determine the left side variable • ICO_BEFOREEQUAL Determine operators like += , -= , ... etc (Bitwise Operators) Operation Description • ICO_BITAND Stack[nSize-1] = Stack[nSize-1] & Stack[nSize] , POP stack[nSize] • ICO_BITOR Stack[nSize-1] = Stack[nSize-1] | Stack[nSize] , POP stack[nSize] • ICO_BITXOR Stack[nSize-1] = Stack[nSize-1] ^ Stack[nSize] , POP stack[nSize] • ICO_BITNOT Stack[nSize] = ! Stack[nSize] • ICO_BITSHL Stack[nSize-1] = Stack[nSize-1] << Stack[nSize] , POP stack[nSize] • ICO_BITSHR Stack[nSize-1] = Stack[nSize-1] >> Stack[nSize] , POP stack[nSize] (For Step) Operation Description • ICO_STEPNUMBER Determine step number in for loop • ICO_POPSTEP POP step number from steps stack • ICO_LOADAFIRST Load the first address of variable name 72.6. Virtual Machine (VM) Instructions 853](https://image.slidesharecdn.com/ringdoc1-251007020742-7f1c885b/75/The-Ring-programming-language-Version-1-4-1-documentation-876-2048.jpg)
Uploaded byMahmoud Samir Fayed
The Ring programming language - Version 1.4.1 documentation
The Ring programming language - Version 1.4.1 documentation
The Ring programming language - Version 1.4.1 documentation
- 2. Ring Documentation Release 1.4.1 Eng.Mahmoud Fayed and Dr. Atif Alamri July 11, 2017
- 3. CONTENTS 1 Applications developedin little hours 1 1.1 Quotes about Ring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 FetchStockData Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.3 Fifteen Puzzle Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.4 TicTacToe Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.5 Squares Puzzle Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.6 Analog Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.7 Werdy Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.8 Fifteen Puzzle Game 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.9 Samples in this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2 Introduction 11 2.1 Motivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.2 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 2.3 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 2.4 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3 Language Design 16 3.1 Why Ring? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.2 Designed for a Clear Goal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.3 Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.4 Trying to be natural . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.5 Encourage Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.6 Transparent Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.7 Visual Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.8 Compact Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 3.9 Define Natural Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 3.10 Define Declarative Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 3.11 Smart Garbage Collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 4 What is new in Ring 1.4.1? 25 4.1 List of changes and new features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 4.2 Better Scripts for Building from Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 4.3 Better Colors for the Modern Style in Ring Notepad . . . . . . . . . . . . . . . . . . . . . . . . . . 26 4.4 Better StdLib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 4.5 Better RingQt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 4.6 New Sample : Sixteen Puzzle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 5 What is new in Ring 1.4? 29 5.1 List of changes and new features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 5.2 Change: Basic Extensions are separated from RingVM . . . . . . . . . . . . . . . . . . . . . . . . . 29 i
- 4. 5.3 The NaturalLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 5.4 New Style is added to Ring Notepad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 5.5 RingREPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 5.6 Convert between Numbers and Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 5.7 Better StdLib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.8 Better WebLib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.9 Better RingQt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 5.10 Qt Class Convertor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 6 What is new in Ring 1.3? 38 6.1 List of changes and new features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 6.2 Better RingQt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 6.3 Better Ring Notepad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 6.4 Ring mode for Emacs Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 6.5 Better StdLib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 6.6 Better Loop|Exit Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 6.7 New Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 6.8 Return Self by Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 6.9 Using ‘<’ and ‘:’ operators as ‘from’ keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 6.10 Embedding Ring in Ring without sharing the State . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 6.11 RingZip Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 6.12 Form Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 7 What is new in Ring 1.2? 51 7.1 List of changes and new features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.2 New Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 7.3 Better Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 7.4 Better Ring Notepad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 7.5 Better RingQt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 7.6 Objects Library for RingQt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 7.7 RingLibCurl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 7.8 Better Call Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 7.9 Using NULL instead of NULLPointer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 7.10 Display Warnings Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 7.11 Better Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 8 What is new in Ring 1.1? 57 8.1 List of changes and new features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 8.2 Better Natural Language Programming Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 8.3 Generate/Execute Ring Object Files (*.ringo) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 8.4 Syntax Flexibility and different styles for I/O and Control Structures . . . . . . . . . . . . . . . . . . 58 8.5 New Functions and Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 8.6 StdLib functions and classes written in Ring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 8.7 RingLibSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 8.8 Demo Project - Game Engine for 2D Games . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 8.9 RingSQLite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 8.10 Better Code Generator for Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 8.11 Using Self.Attribute in the Class Region to define new attributes . . . . . . . . . . . . . . . . . . . . 65 8.12 Using This.Attribute in nested Braces inside the Class Methods . . . . . . . . . . . . . . . . . . . . 65 8.13 Better Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 9 Building From Source Code 67 9.1 Building using Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 9.2 Building using Ubuntu Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 9.3 Building using MacOS X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 ii
- 5. 9.4 Building usingCMake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 10 How to contribute? 72 10.1 Special thanks to contributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 10.2 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 10.3 Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 10.4 Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 10.5 Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 10.6 Editors Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 10.7 Libraries in Ring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 10.8 Extensions in C/C++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 10.9 Compiler and Virtual Machine (VM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 10.10 Ideas and suggestions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 11 Getting Started - First Style 74 11.1 Hello World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 11.2 Run the program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 11.3 Not Case-Sensitive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 11.4 Multi-Line literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 11.5 Getting Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.6 No Explicit End For Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 11.7 Writing Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 12 Getting Started - Second Style 76 12.1 Hello World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 12.2 Run the program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 12.3 Not Case-Sensitive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 12.4 Multi-Line literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 12.5 Getting Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 12.6 No Explicit End For Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 12.7 Writing Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 13 Getting Started - Third Style 78 13.1 Hello World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 13.2 Run the program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 13.3 Not Case-Sensitive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 13.4 Multi-Line literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 13.5 Getting Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 13.6 No Explicit End For Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 13.7 Writing Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 14 Using Ring Notepad 80 14.1 Ring Notepad - Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 14.2 Creating and running your first Console Application . . . . . . . . . . . . . . . . . . . . . . . . . . 81 14.3 Creating and running your first GUI/Mobile Application . . . . . . . . . . . . . . . . . . . . . . . . 83 14.4 Creating and running your first Web Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 14.5 Creating and running your first Desktop/Mobile Game . . . . . . . . . . . . . . . . . . . . . . . . . 85 15 Using Other Code Editors 87 15.1 Using Notepad++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 15.2 Using Geany . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 15.3 Using Atom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 15.4 Using Sublime Text 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 15.5 Using Visual Studio IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 15.6 Using Emacs Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 iii
- 6. 16 Variables 93 16.1Dynamic Typing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 16.2 Deep Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 16.3 Weakly Typed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 17 Operators 95 17.1 Arithmetic Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 17.2 Relational Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 17.3 Logical Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 17.4 Bitwise Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 17.5 Assignment Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 17.6 Misc Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 17.7 Operators Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 18 Control Structures - First Style 98 18.1 Branching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 18.2 Looping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 18.3 Using The Step option with For in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 18.4 Using For in to modify lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 18.5 Do Again Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 18.6 Exit Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 18.7 Exit from two loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 18.8 Exit/Loop inside sub functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 18.9 Short-circuit evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 18.10 Comments about evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 19 Control Structures - Second Style 105 19.1 Branching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 19.2 Looping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 19.3 Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 20 Control Structures - Third Style 108 20.1 Branching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 20.2 Looping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 20.3 Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 21 Getting Input 113 21.1 Give Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 21.2 GetChar() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 21.3 Input() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 22 Functions 115 22.1 Define Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 22.2 Call Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 22.3 Declare parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 22.4 Send Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 22.5 Main Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 22.6 Variables Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 22.7 Return Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 22.8 Recursion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 23 Program Structure 119 23.1 Source Code File Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 23.2 Using Many Source Code Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 iv
- 7. 24 Lists 120 24.1Create Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 24.2 Add Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 24.3 Get List Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 24.4 Delete Item From List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 24.5 Get List Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 24.6 Set List Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 24.7 Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 24.8 Sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 24.9 Reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 24.10 Insert Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 24.11 Nested Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 24.12 Copy Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 24.13 First-class lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 24.14 Using Lists during definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 24.15 Passing Lists to Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 24.16 Access List Items by String Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 24.17 Passing Parameters Using List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 24.18 Swap Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 25 Strings 128 25.1 String Literals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 25.2 Get String Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 25.3 Convert Letters Case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 25.4 Access String Letters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 25.5 Left() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 25.6 Right() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 25.7 Trim() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 25.8 Copy() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 25.9 Lines() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 25.10 Substr() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 25.11 Find substring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 25.12 Get substring from position to end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 25.13 Get Number of Characters From Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 25.14 Transform Substring To Another Substring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 25.15 strcmp() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 25.16 str2list() and list2str() Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 26 Date and Time 134 26.1 Clock() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 26.2 ClocksPerSecond() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 26.3 Time() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 26.4 Date() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 26.5 TimeList() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 26.6 AddDays() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 26.7 DiffDays() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 26.8 EpochTime() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 27 Check Data Type and Conversion 138 27.1 Check Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 27.2 IsString() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 27.3 IsNumber() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 27.4 IsList() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 27.5 Type() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 v
- 8. 27.6 IsNULL() Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 27.7 Check Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 27.8 IsAlNum() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 27.9 IsAlpha() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 27.10 IsCntrl() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 27.11 IsDigit() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 27.12 IsGraph() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 27.13 IsLower() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 27.14 IsPrint() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 27.15 IsPunct() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 27.16 IsSpace() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 27.17 IsUpper() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 27.18 IsXdigit() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 27.19 Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 27.20 Number() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 27.21 String() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 27.22 Ascii() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 27.23 Char() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 27.24 Hex() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 27.25 Dec() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 27.26 Str2hex() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 27.27 Hex2str() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 28 Mathematical Functions 146 28.1 List of functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 28.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 28.3 Random() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 28.4 Unsigned() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 28.5 Decimals() Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 29 Files 151 29.1 Read() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 29.2 Write() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 29.3 Dir() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 29.4 Rename() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 29.5 Remove() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 29.6 Fopen() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 29.7 Fclose() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 29.8 Fflush() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 29.9 Freopen() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 29.10 Tempfile() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 29.11 Tempname() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 29.12 Fseek() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 29.13 Ftell() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 29.14 Rewind() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 29.15 Fgetpos() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 29.16 Fsetpos() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 29.17 Clearerr() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 29.18 Feof() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 29.19 Ferror() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 29.20 Perror() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 29.21 Fgetc() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 29.22 Fgets() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 29.23 Fputc() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 vi
- 9. 29.24 Fputs() Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 29.25 Ungetc() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 29.26 Fread() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 29.27 Fwrite() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 29.28 Fexists() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 29.29 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 29.30 Numbers and Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 30 System Functions 161 30.1 System() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 30.2 SysGet() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 30.3 IsMSDOS() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 30.4 IsWindows() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 30.5 IsWindows64() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 30.6 IsUnix() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 30.7 IsMacOSX() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 30.8 IsLinux() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 30.9 IsFreeBSD() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 30.10 IsAndroid() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 30.11 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 30.12 Windowsnl() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 30.13 Get Command Line Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 30.14 Get Active Source File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 30.15 PrevFileName() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 30.16 CurrentDir() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 30.17 ExeFileName() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 30.18 ChDir() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 30.19 ExeFolder() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 30.20 Version() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 31 Eval() and Debugging 167 31.1 Try/Catch/Done . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 31.2 Eval() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 31.3 Raise() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 31.4 Assert() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 32 Demo Programs 170 32.1 Language Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 32.2 Main Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 33 ODBC Functions 174 33.1 odbc_init() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 33.2 odbc_drivers() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 33.3 odbc_datasources() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 33.4 odbc_close() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 33.5 Print List of ODBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 33.6 Print List of ODBC Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 33.7 odbc_connect() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 33.8 odbc_disconnect() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 33.9 Open and Close Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 33.10 odbc_execute() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 33.11 odbc_colcount() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 33.12 odbc_fetch() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 33.13 odbc_getdata() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 33.14 Execute Query and Print Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 vii
- 10. 33.15 odbc_tables() Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 33.16 odbc_columns() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 33.17 odbc_autocommit() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 33.18 odbc_commit() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 33.19 odbc_rollback() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 33.20 Transactions and Using Commit and Rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 33.21 Save and Restore images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 34 MySQL Functions 183 34.1 MySQL_Info() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 34.2 MySQL_Init() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 34.3 MySQL_Error() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 34.4 MySQL_Connect() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 34.5 MySQL_Close() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 34.6 MySQL_Query() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 34.7 Create Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 34.8 Create Table and Insert Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 34.9 MySQL_Insert_ID() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 34.10 MySQL_Result() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 34.11 MySQL_Next_Result() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 34.12 Print Query Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 34.13 MySQL_Columns() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 34.14 MySQL_Result2() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 34.15 MySQL_Escape_String() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 34.16 Save Image inside the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 34.17 Restore Image From The Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 34.18 MySQL_AutoCommit() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 34.19 MySQL_Commit() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 34.20 MySQL_Rollback() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 34.21 Transaction Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 35 SQLite Functions 192 35.1 sqlite_init() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 35.2 sqlite_open() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 35.3 sqlite_execute() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 35.4 sqlite_close() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 35.5 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 36 Security and Internet Functions 195 36.1 MD5() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 36.2 SHA1() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 36.3 SHA256() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 36.4 SHA512() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 36.5 SHA384() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 36.6 SHA224() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 36.7 Encrypt() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 36.8 Decrypt() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 36.9 Encryption and Decryption Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 36.10 File Hash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 36.11 Randbytes() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 36.12 Download() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 36.13 SendEmail() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 37 Object Oriented Programming (OOP) 200 37.1 Classes and Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 viii
- 11. 37.2 Access ObjectsUsing Braces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 37.3 Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 37.4 Setter and Getter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 37.5 Private Attributes and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 37.6 Operator Overloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 37.7 Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 37.8 Dynamic Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 37.9 Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 37.10 Printing Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 37.11 Find() and List of Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208 37.12 Sort() and list of objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 37.13 Using Self.Attribute and Self.Method() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 37.14 Using This.Attribute and This.Method() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 38 Functional Programming 213 38.1 Pure Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 38.2 First-class Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 38.3 Higher-order Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 38.4 Anonymous and Nested Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 38.5 Equality of functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 39 Reflection and Meta-programming 218 39.1 locals() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 39.2 globals() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 39.3 functions() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 39.4 cfunctions() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 39.5 islocal() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 39.6 isglobal() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 39.7 isfunction() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 39.8 iscfunction() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 39.9 packages() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 39.10 ispackage() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 39.11 classes() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 39.12 isclass() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 39.13 packageclasses() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 39.14 ispackageclass() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 39.15 classname() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 39.16 objectid() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 39.17 isobject() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 39.18 attributes() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 39.19 methods() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 39.20 isattribute() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 39.21 isprivateattribute() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227 39.22 ismethod() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 39.23 isprivatemethod() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 39.24 addattribute() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 39.25 addmethod() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 39.26 getattribute() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 39.27 setattribute() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 39.28 mergemethods() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 39.29 packagename() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 40 Stdlib Functions 235 40.1 puts() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 ix
- 12. 40.2 print() function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 40.3 getstring() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 40.4 getnumber() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 40.5 apppath() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 40.6 justfilepath() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 40.7 justfilename() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 40.8 value() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 40.9 times() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 40.10 map() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 40.11 filter() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 40.12 split() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 40.13 splitmany() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 40.14 newlist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 40.15 capitalized() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 40.16 isspecial() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 40.17 isvowel() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 40.18 linecount() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 40.19 factorial() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 40.20 fibonacci() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 40.21 isprime() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 40.22 sign() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 40.23 list2file() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 40.24 file2list() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 40.25 startswith() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 40.26 endswith() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 40.27 gcd() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 40.28 lcm() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 40.29 sumlist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 40.30 prodlist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 40.31 evenorodd() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 40.32 factors() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 40.33 palindrome() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 40.34 isleapyear() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 40.35 binarydigits() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 40.36 matrixmulti() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 40.37 matrixtrans() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 40.38 dayofweek() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 40.39 permutation() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 40.40 readline() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 40.41 substring() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 40.42 changestring() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 40.43 sleep() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 40.44 ismainsourcefile() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 40.45 direxists() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 40.46 makedir() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 40.47 fsize() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 40.48 trimall() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 40.49 trimleft() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 40.50 trimright() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 40.51 epochtime() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 41 Stdlib Classes 251 41.1 StdBase Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 41.2 String Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 x
- 13. 41.3 List Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 41.4 Stack Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 41.5 Queue Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 41.6 HashTable Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 41.7 Tree Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 41.8 Math Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 41.9 DateTime Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 41.10 File Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 41.11 System Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 41.12 Debug Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 41.13 DataType Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 41.14 Conversion Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 41.15 ODBC Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269 41.16 MySQL Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270 41.17 SQLite Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271 41.18 Security Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 41.19 Internet Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273 42 Declarative Programming using Nested Structures 274 42.1 Creating Objects inside Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274 42.2 Composition and Returning Objects and Lists by Reference . . . . . . . . . . . . . . . . . . . . . . 275 42.3 Executing code after the end of object access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 42.4 Declarative Programming on the top of Object-Oriented . . . . . . . . . . . . . . . . . . . . . . . . 277 42.5 More beautiful Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 43 Natural Language Programming 280 43.1 History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 43.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 43.3 Change the Ring Keyword ‘And’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 43.4 Change the Ring Operator ‘+’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282 43.5 Change the ‘=’ operator to ‘is’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283 43.6 Using Eval() with our Natural Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284 43.7 BraceStart and BraceEnd Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285 43.8 BraceExprEval Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 43.9 Real Natural Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 43.10 BraceError() Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287 43.11 Clean Natural Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288 44 Using the Natural Library 290 44.1 Natural Library - Demo Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290 44.2 Defining Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 44.3 Natural Library - Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295 44.4 Defining commands using classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295 45 Web Development (CGI Library) 297 45.1 Configure the Apache web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 45.2 Ring CGI Hello World Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298 45.3 Hello World Program using the Web Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298 45.4 Web Library Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 45.5 HTTP Get Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 45.6 HTTP POST Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304 45.7 Upload Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306 45.8 Cookies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309 45.9 URL Encode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 45.10 Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 xi
- 14. 45.11 HTML SpecialCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314 45.12 Hash Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315 45.13 Random Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317 45.14 HTML Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318 45.15 HTML Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320 45.16 Gradient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321 45.17 Generating Pages using Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322 45.18 Using Bootstrap Library using Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 45.19 Using Bootstrap Library using Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327 45.20 CRUD Example using MVC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330 45.21 Users registration and Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332 45.22 Database, ModelBase & ControllerBase classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338 45.23 WebLib API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 45.24 Application Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 45.25 Page Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 45.26 ScriptFunctions Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347 45.27 StyleFunctions Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 46 Using RingLibCurl 349 46.1 Get Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 46.2 Post Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 46.3 Facebook Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349 46.4 Save Output to String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350 47 Using RingZip 353 47.1 Create Zip File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 47.2 Extract Zip File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 47.3 Print Files in Zip file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 47.4 Using RingZip Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 47.5 Zip Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 47.6 ZipEntry Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 48 Graphics and 2D Games programming using RingAllegro 356 48.1 Drawing, Animation and Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356 48.2 Using TrueType Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362 48.3 Playing Sound Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363 48.4 Scaling and Rotating Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364 48.5 Display Transparent Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365 48.6 Using Threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366 49 Using RingLibSDL 369 49.1 Create Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369 49.2 Display Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369 49.3 Switch between two images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 49.4 Draw Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 49.5 Display PNG Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371 49.6 Use TTF Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371 49.7 Display Transparent Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371 49.8 Close Window Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 49.9 Mouse Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373 49.10 Play Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374 50 Demo Project - Game Engine for 2D Games 376 50.1 Project Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376 50.2 Graphics Library bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376 xii
- 15. 50.3 Interface tographics library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 50.4 Game Engine Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 50.5 Games Layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377 50.6 Game Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 50.7 GameObject Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 50.8 Sprite Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 50.9 Text Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 50.10 Animate Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380 50.11 Sound Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380 50.12 Map Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380 50.13 Using the Game Engine - Creating the Game Window . . . . . . . . . . . . . . . . . . . . . . . . . 381 50.14 Using the Game Engine - Drawing Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381 50.15 Using the Game Engine - Moving Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382 50.16 Using the Game Engine - Playing Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384 50.17 Using the Game Engine - Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385 50.18 Using the Game Engine - Animation and Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 386 50.19 Using the Game Engine - Sprite - Automatic Movement using Keyboard . . . . . . . . . . . . . . . 388 50.20 Using the Game Engine - Sprite - Keypress event . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389 50.21 Using the Game Engine - Sprite - Mouse event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389 50.22 Using the Game Engine - Sprite - State event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390 50.23 Using the Game Engine - Animate - Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391 50.24 Using the Game Engine - Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393 50.25 Using the Game Engine - Map Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395 50.26 Using the Game Engine - Object and Drawing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396 50.27 Stars Fighter Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399 50.28 Flappy Bird 3000 Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407 50.29 Super Man 2016 Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414 51 Building Games For Android 426 51.1 Download Requirements and Update the Android SDK . . . . . . . . . . . . . . . . . . . . . . . . . 426 51.2 Project Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426 51.3 Building the project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427 52 Desktop and Mobile development using RingQt 429 52.1 The First GUI Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429 52.2 Using Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431 52.3 Using the QTextEdit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432 52.4 Using the QListWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433 52.5 Using QTreeView and QFileSystemModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436 52.6 Using QTreeWidget and QTreeWidgetItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 52.7 Using QComboBox Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438 52.8 Creating Menubar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439 52.9 Creating Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442 52.10 Creating StatusBar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443 52.11 Using QDockWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444 52.12 Using QTabWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446 52.13 Using QTableWidget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447 52.14 Using QProgressBar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 52.15 Using QSpinBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449 52.16 Using QSlider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450 52.17 Using QDateEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451 52.18 Using QDial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452 52.19 Using QWebView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 52.20 Using QCheckBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 xiii
- 16. 52.21 Using QRadioButtonand QButtonGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 52.22 Adding Hyperlink to QLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459 52.23 QVideoWidget and QMediaPlayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460 52.24 Using QFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 52.25 Display Image using QLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 52.26 Menubar and StyleSheet Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 52.27 QLineEdit Events and QMessageBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 52.28 Other Widgets Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468 52.29 Using the QTimer Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470 52.30 Using QProgressBar and Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471 52.31 Display Scaled Image using QLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472 52.32 Using the QFileDialog Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473 52.33 Drawing using QPainter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474 52.34 Printing using QPrinter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 52.35 Creating More than one Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 52.36 Playing Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 52.37 Using the QColorDialog Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 52.38 Using qLCDNumber Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 52.39 Movable Label Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 52.40 QMessagebox Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481 52.41 Using QInputDialog Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 52.42 Dialog Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 52.43 KeyPress and Mouse Move Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 52.44 Moving Objects using the Mouse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 52.45 Inheritance from GUI Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490 52.46 Using QDesktopWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491 52.47 Rotate Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492 52.48 Change Focus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494 52.49 Regular Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 52.50 Simple Client and Server Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 52.51 Dynamic Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498 52.52 Weight History Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 52.53 Notepad Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 52.54 The Cards Game . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518 52.55 Classes and their Methods to use the default events . . . . . . . . . . . . . . . . . . . . . . . . . . . 524 52.56 Methods to use Events with Events Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527 52.57 The Difference between Qt and RingQt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528 52.58 RingQt Classes and their Qt Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529 52.59 New Classes names - Index Start from 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529 53 Building RingQt Applications for Mobile 530 53.1 Download Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 53.2 Update the Android SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 53.3 Install Qt for Android . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530 53.4 Comments about developing for Android using RingQt . . . . . . . . . . . . . . . . . . . . . . . . . 531 54 Objects Library for RingQt Application 533 54.1 Library Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533 54.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533 54.3 Open_WindowAndLink() Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536 54.4 Objects Library Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537 55 Using the Form Designer 538 55.1 The Designer Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539 xiv
- 17. 55.2 The Toolbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539 55.3 The Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539 55.4 Running Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540 55.5 Events Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540 55.6 Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 55.7 Menubar Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543 55.8 Window Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544 55.9 Entering Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545 55.10 Using Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545 55.11 More Samples and Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545 56 Scope Rules for Variables and Attributes 546 56.1 Three Scopes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546 56.2 Defining Variables and Variables Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546 56.3 How Ring find the variable? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547 56.4 Using Object.Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547 56.5 The Self Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547 56.6 How Ring Define Variables and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548 56.7 Conflict between Global Variables and Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . 548 56.8 Conflict between Class Attributes and Local Variables . . . . . . . . . . . . . . . . . . . . . . . . . 549 56.9 Using Braces to access objects inside Class Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 550 56.10 Accessing the class attributes from braces inside class methods . . . . . . . . . . . . . . . . . . . . 553 56.11 Creating a Class for each Window in GUI applications . . . . . . . . . . . . . . . . . . . . . . . . . 554 56.12 Conflict between self inside braces and self in the class region . . . . . . . . . . . . . . . . . . . . . 555 56.13 Using braces to escape from the current object scope . . . . . . . . . . . . . . . . . . . . . . . . . . 558 56.14 Summary of Scope Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559 57 Scope Rules for Functions and Methods 561 57.1 How Ring find the Functions and Methods? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561 57.2 Example about Sharing Names between Functions and Methods . . . . . . . . . . . . . . . . . . . . 562 57.3 Calling a function sharing the name with a method in the current class . . . . . . . . . . . . . . . . . 563 58 Syntax Flexibility 565 58.1 Change Language Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565 58.2 Change Language Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566 58.3 Load Syntax Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567 58.4 Using “()” around the function parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568 58.5 Using Semi-colon after and between statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568 58.6 Using $ and @ in the start of the variable name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569 58.7 Using the ‘elseif’ keyword as ‘but’ in if statement . . . . . . . . . . . . . . . . . . . . . . . . . . . 569 58.8 Using the ‘else’ keyword as ‘other’ in switch statement . . . . . . . . . . . . . . . . . . . . . . . . . 570 58.9 Using the ‘end’ keyword in different control structures . . . . . . . . . . . . . . . . . . . . . . . . . 570 58.10 Using braces to start and end different control structures . . . . . . . . . . . . . . . . . . . . . . . . 571 58.11 Using ‘put’ and ‘get’ as ‘see’ and ‘give’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572 58.12 Using ‘case’ as ‘on’ in switch statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572 58.13 Using ‘def’ as ‘func’ in functions/methods definition . . . . . . . . . . . . . . . . . . . . . . . . . . 573 59 Distributing Ring Applications 574 59.1 Distributing Applications for Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574 59.2 Protecting the Source Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574 59.3 Creating Windows Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575 59.4 Using C/C++ Compiler and Linker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575 59.5 Distributing Applications and Games for Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575 60 Command Line Options 576 xv
- 18. 60.1 Printing Tokens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576 60.2 Printing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578 60.3 Printing Intermediate Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582 60.4 Printing Final Intermediate Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585 60.5 CGI Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589 60.6 No Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589 60.7 Printing Instruction Operation Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589 60.8 Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589 60.9 Generate Object File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590 61 Low Level Functions 591 61.1 callgc() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591 61.2 varptr() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592 61.3 space() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592 61.4 nullpointer() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593 61.5 object2pointer() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593 61.6 pointer2object() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593 61.7 ptrcmp() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594 61.8 ringvm_cfunctionslist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594 61.9 ringvm_functionslist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595 61.10 ringvm_classeslist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595 61.11 ringvm_packageslist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596 61.12 ringvm_memorylist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597 61.13 ringvm_calllist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599 61.14 ringvm_fileslist() function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600 62 Introduction 601 62.1 Embedding Ring in Ring without sharing the State . . . . . . . . . . . . . . . . . . . . . . . . . . . 601 62.2 Serial Execution of Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602 63 Extension using the C/C++ languages 603 63.1 ring_ext.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603 63.2 ring_ext.c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603 63.3 Module Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604 63.4 Function Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605 63.5 Check Parameters Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605 63.6 Display Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606 63.7 Check Parameters Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606 63.8 Get Parameters Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606 63.9 Return Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607 63.10 Function Prototype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607 63.11 Sin() Function Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607 63.12 Fopen() and Fclose() Functions Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607 63.13 Ring API - List Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608 63.14 Ring API - String Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610 63.15 MySQL_Columns() Function Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610 63.16 Dynamic/Shared Libraries (DLL/So) and LoadLib() function . . . . . . . . . . . . . . . . . . . . . 611 64 Embedding Ring Language in C/C++ Programs 613 64.1 Ring State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613 64.2 Ring State Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613 64.3 Ring State Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614 65 Code Generator for wrapping C/C++ Libraries 616 65.1 Using the tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616 xvi
- 19. 65.2 Configuration file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616 65.3 Using the function prototype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616 65.4 Adding code to the generated code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618 65.5 Prefix for Functions Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618 65.6 Generate function to wrap structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618 65.7 Determine Structure Members Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619 65.8 Defining Contants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619 65.9 Register New Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619 65.10 Writing comments in the configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620 65.11 Executing code during code generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620 65.12 Enum and Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620 65.13 Filtering using Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621 65.14 Configuration file for the Allegro Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621 65.15 Threads Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622 65.16 Code Generator Rules for Wrapping C++ Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624 65.17 Using configuration file that wrap C++ Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624 65.18 Configuration file for the Qt Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624 65.19 Configuration Files Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634 66 RingLibCurl Functions Reference 635 67 RingLibZip Functions Reference 637 68 RingAllegro Functions Reference 638 69 RingLibSDL Functions Reference 657 70 RingQt Classes Reference 673 70.1 QApp Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673 70.2 QDesktopServices Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673 70.3 QTest Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673 70.4 QObject Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674 70.5 QWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674 70.6 QLabel Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680 70.7 QPushButton Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681 70.8 QBitmap Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681 70.9 QPixmap Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681 70.10 QPixmap2 Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682 70.11 QIcon Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682 70.12 QSize Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682 70.13 QLineEdit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682 70.14 QVBoxLayout Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684 70.15 QHBoxLayout Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685 70.16 QTextEdit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685 70.17 QListWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687 70.18 QTreeView Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689 70.19 QDir Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691 70.20 QFileSystemModel Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691 70.21 QTreeWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692 70.22 QTreeWidgetItem Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695 70.23 QComboBox Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696 70.24 QMenuBar Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698 70.25 QMenu Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698 70.26 QToolBar Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699 70.27 QMainWindow Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700 xvii
- 20. 70.28 QStatusBar Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701 70.29 QDockWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702 70.30 QTabWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703 70.31 QTableWidgetItem Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704 70.32 QFrame Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705 70.33 QFrame2 Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706 70.34 QFrame3 Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706 70.35 QAbstractScrollArea Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706 70.36 QAbstractItemView Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706 70.37 QTableView Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708 70.38 QTableWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710 70.39 QProgressBar Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712 70.40 QSpinBox Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713 70.41 QAbstractSlider Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713 70.42 QSlider Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714 70.43 QDateEdit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715 70.44 QDateTimeEdit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715 70.45 QAbstractSpinBox Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716 70.46 QDial Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717 70.47 QWebView Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718 70.48 QUrl Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719 70.49 QCheckBox Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720 70.50 QAbstractButton Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720 70.51 QRadioButton Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721 70.52 QButtonGroup Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722 70.53 QMediaPlayer Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722 70.54 QMediaPlaylist Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723 70.55 QVideoWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724 70.56 QAction Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724 70.57 QEvent Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726 70.58 QMessageBox Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726 70.59 QTimer Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727 70.60 QFileDialog Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728 70.61 QPainter Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729 70.62 QPainter2 Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732 70.63 QPicture Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732 70.64 QPen Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732 70.65 QColor Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733 70.66 QPrinter Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735 70.67 QFont Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737 70.68 QBrush Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738 70.69 QByteArray Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739 70.70 QIODevice Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741 70.71 QAbstractSocket Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741 70.72 QNetworkProxy Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743 70.73 QTcpSocket Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744 70.74 QTcpServer Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744 70.75 QHostAddress Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745 70.76 QHostInfo Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746 70.77 QFileInfo Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746 70.78 QDirModel Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747 70.79 QFontDialog Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748 70.80 QDialog Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749 70.81 QTextCursor Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749 xviii
- 21. 70.82 QColorDialog Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751 70.83 QStringList Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751 70.84 QKeySequence Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753 70.85 QLCDNumber Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753 70.86 QInputDialog Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753 70.87 QAllEvents Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755 70.88 QDesktopWidget Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757 70.89 QRect Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757 70.90 QTextDocument Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759 70.91 QTextBlock Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761 70.92 QTime Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762 70.93 QListWidgetItem Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762 70.94 QSystemTrayIcon Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763 70.95 QDate Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764 70.96 QTextCodec Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765 70.97 QSqlDatabase Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765 70.98 QSqlDriver Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766 70.99 QSqlQuery Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766 70.100QSqlError Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767 70.101QSqlIndex Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768 70.102QSqlRecord Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768 70.103QSqlField Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769 70.104QSqlDriverCreatorBase Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769 70.105QVariant Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770 70.106QNetworkRequest Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771 70.107QNetworkAccessManager Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771 70.108QNetworkReply Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772 70.109QPainterPath Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773 70.110QImage Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774 70.111RingCodeHighlighter Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776 70.112QXmlStreamReader Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776 70.113QXmlStreamWriter Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777 70.114QXmlStreamNotationDeclaration Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778 70.115QXmlStreamNamespaceDeclaration Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779 70.116QXmlStreamEntityResolver Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779 70.117QXmlStreamEntityDeclaration Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779 70.118QXmlStreamAttributes Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779 70.119QXmlStreamAttribute Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780 70.120QThread Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780 70.121QThreadPool Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781 70.122QRegularExpression Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781 70.123QRegularExpressionMatch Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782 70.124QRegularExpressionMatchIterator Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782 70.125QJsonArray Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783 70.126QJsonDocument Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784 70.127QJsonObject Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784 70.128QJsonParseError Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785 70.129QJsonValue Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785 70.130QPlainTextEdit Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785 70.131CodeEditor Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788 70.132QGridLayout Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788 70.133QTextCharFormat Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789 70.134QCameraViewfinder Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791 70.135QGraphicsVideoItem Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791 xix
- 22. 70.136QVideoWidgetControl Class .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791 70.137QCamera Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791 70.138QCameraImageCapture Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792 70.139QMediaObject Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793 70.140QHeaderView Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793 70.141QFontMetrics Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795 70.142QSplashScreen Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796 70.143QBoxLayout Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797 70.144QLayout Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797 70.145QLinearGradient Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798 70.146QGradient Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798 70.147QPointF Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799 70.148QPoint Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799 70.149QScrollArea Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799 70.150QSplitter Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800 70.151QCompleter Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801 70.152QCompleter2 Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802 70.153QCompleter3 Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802 70.154QString2 Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802 70.155QProcess Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802 70.156QMdiArea Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803 70.157QMdiSubWindow Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804 70.158QCursor Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805 70.159QListView Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805 70.160QAxObject Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806 70.161QAxBase Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806 70.162QUuid Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807 70.163QToolButton Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807 70.164QSerialPort Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808 70.165QSerialPortInfo Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809 71 Frequently Asked Questions (FAQ) 810 71.1 Why do we need Yet Another Programming Language (YAPL)? . . . . . . . . . . . . . . . . . . . . 810 71.2 Why Ring is weakly typed? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811 71.3 What are the advantages to using Ring over Lisp or Smalltalk? . . . . . . . . . . . . . . . . . . . . . 811 71.4 Why Ring is largely focussed on UI creation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812 71.5 Is Ring some sort of improvement over PHP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812 71.6 What are the advantages to using Ring over native C or C++? . . . . . . . . . . . . . . . . . . . . . 812 71.7 What is the difference between Ring and Python? And is Ring Open Source? . . . . . . . . . . . . . 812 71.8 What are the advantages to using Ring over Perl, PHP, Python or Ruby? . . . . . . . . . . . . . . . . 813 71.9 What are the advantages to using Ring over Tcl or Lua? . . . . . . . . . . . . . . . . . . . . . . . . 814 71.10 What are the advantages to using Ring over C# or Java? . . . . . . . . . . . . . . . . . . . . . . . . 814 71.11 The documentation says functional programming is supported, but then this happens? . . . . . . . . 814 71.12 Why the ability to define your own languages Instead of just handing over the syntax so you can parse it using whatever code you like? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815 71.13 Why you can specify the number of loops you want to break out of? . . . . . . . . . . . . . . . . . . 815 71.14 Why Ring uses ‘See’, ‘Give’, ‘But’ and ‘Ok’ Keywords? . . . . . . . . . . . . . . . . . . . . . . . . 815 71.15 What is the philosophy behind data types in Ring? . . . . . . . . . . . . . . . . . . . . . . . . . . . 816 71.16 What about the Boolean values in Ring? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816 71.17 What is the goal of including the “Main” function in Ring? . . . . . . . . . . . . . . . . . . . . . . . 817 71.18 Why the list index start from 1 in Ring? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818 71.19 Is there constructor methods in Ring? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818 71.20 What happens when we create a new object? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819 71.21 Can we use the attributes by accessing the Getter and Setter methods? . . . . . . . . . . . . . . . . . 820 xx
- 23. 71.22 Why shoulda search of global names be made while defining the class attributes? . . . . . . . . . . 821 71.23 Why Ring doesn’t avoid the conflict between Global Variables and Class Attributes Names? . . . . . 822 71.24 Where can I write a program and execute it? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822 71.25 How to get the file size using ftell() and fseek() functions? . . . . . . . . . . . . . . . . . . . . . . . 823 71.26 How to get the current source file path? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823 71.27 What about predefined parameters or optional parameters in functions? . . . . . . . . . . . . . . . . 823 71.28 How to print keys or values only in List/Dictionary? . . . . . . . . . . . . . . . . . . . . . . . . . . 824 71.29 Why I get a strange result when printing nl with lists? . . . . . . . . . . . . . . . . . . . . . . . . . 824 71.30 Could you explain the output of the StrCmp() function? . . . . . . . . . . . . . . . . . . . . . . . . 825 71.31 How to use many source code files in the project? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825 71.32 Why this example use the GetChar() twice? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826 71.33 How to use NULL and ISNULL() function? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827 71.34 How to print lists that contains objects? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828 71.35 How to insert an item to the first position in the list? . . . . . . . . . . . . . . . . . . . . . . . . . . 828 71.36 How to print new lines and other characters? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829 71.37 Why we don’t use () after the qApp class name? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829 71.38 Why the window title bar is going outside the screen? . . . . . . . . . . . . . . . . . . . . . . . . . 829 71.39 How to create an array of buttons in GUI applications? . . . . . . . . . . . . . . . . . . . . . . . . . 830 71.40 How to Close a window then displaying another one? . . . . . . . . . . . . . . . . . . . . . . . . . . 831 71.41 How to create a Modal Window? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831 71.42 How can I disable maximize button and resize window? . . . . . . . . . . . . . . . . . . . . . . . . 832 71.43 How to use SQLite using ODBC? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833 71.44 Can I connect to dbase/harbour database? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834 71.45 Why setClickEvent() doesn’t see the object methods directly? . . . . . . . . . . . . . . . . . . . . . 835 71.46 Why I get Calling Function without definition Error? . . . . . . . . . . . . . . . . . . . . . . . . . . 835 71.47 Can Ring work on Windows XP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836 71.48 How to extend RingQt and add more classes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836 71.49 How to add Combobox and other elements to the cells of a QTableWidget? . . . . . . . . . . . . . . 839 71.50 How to perform some manipulations on selected cells in QTableWidget? . . . . . . . . . . . . . . . 839 72 Language Reference 841 72.1 Language Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841 72.2 Language Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842 72.3 Compiler Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843 72.4 Runtime Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844 72.5 Language Grammar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845 72.6 Virtual Machine (VM) Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847 73 Resources 854 73.1 Ring Language Website . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854 73.2 Ring Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854 73.3 Contact the Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854 Index 855 xxi
- 24. CHAPTER ONE APPLICATIONS DEVELOPED INLITTLE HOURS Ring is a new programming language that focuses on the Natural Language Programming and Declarative Program- ming paradigms and will let you think different about programming and how to solve your problems in a better way. It’s just released in 2016.01.25! In little days we got thousands of downloads and many developers started learning and using the language. Their feedback are the secret behind the language progress and success. They said that Ring is powerful, beautiful and easy to learn, Some of them provided good examples about what can be done using Ring in little hours. They are very happy with the language productivity. 1.1 Quotes about Ring “I like Smalltalk very much but now I like Ring better!” , Gal Zsolt (Hungary) “I find the language and its syntax very natural and easy to follow.” , Bhudda (United States) “Very nice approach for a new language.” , Matth Moestl (Austria) “Very interesting! I will keep an eye on it.!” , Eslipak (Argentina) “I’d like to see some benchmarks. Otherwise, at first glance, it looks really promising.” , Alex Deva (Sweden) “Excellent” , Liju Sankar (United States) “I wish you the best with this project.” , David O’Neil (United States) “Just fantastic.” , Jose Antonio (Mexico) “This looks like it was developed by some very competent people.” , Jim Clack (United States) “The Ring programming language seems pretty interesting so far.” , Eric Johnson (United States) “Thank you for this awesome language and wonderful ready to use Qt binding.” , Martial FAESSEL “I think it’s great what he does for the community of developers and novice programming.” , Marino Esteban “Ring is just awesome. The language is so cool and fluent. I am sure it’s going to be BIG.” , Ahmed Zain “What a proud, really wish you Eng. Mahmoud Samir and Your Team moving forward ^_^ and from now , considered me a big fan of the Ring programming language.” , Zainab Mahmoud “Well guys I love this language and it appears that you have created perfect language.” , Moemen Ghulmi “Good work Mahmoud, I’ve installed ring pl, and it’s very perfect language.” , Ahmed Omar (Egypt) “Thanks for this great startup programming language. I wish you best of luck.” , Elkhouaja Khalid “Congratulations! I am very happy and I wish you Success and good luck.” , Abobasmla Hassan “Good Features of multi-use language on the Web, Mobile and Desktop.” , Abdelrhman Haider 1
- 25. Ring Documentation, Release1.4.1 “Very interesting effort.” , Giannakakis Kostas (Greece) “I am too lazy to open comment window and write message. But in your case I must say “Perfect” Really, create new remarkable language like your Ring is really perfect job. Even create editor for your language in your language with only few rows... Even noticed in rosettacode.org ! I read your previous articles and I tried these examples a few days ago and I will continue. I love Ring. P.S.: Anders Hejlsberg, Niklaus Wirth, Bjarne Stroustrup, Ada Lovelace Hall of fame is waiting....” , Martin Nedopil (Czech Republic ) “Ring seems very attractive to me through its very easy design and the Qt bindings. I like its declarative approach and the generous documentation.” , Shalok Shalom (Austria) “Ring (and plenty of extension library + Qt) is wonderful.” , Kovacs Attila (Hungary) “Since two days I’m trying Ring and I’m really impressed, in add to power commands and easy use, it’s really very efficient and very fast. Each day I hope to find the couple of the year PWCT+RING ... Maybe for my Christmas gift!!!! HO HO HO HO Continue your fantastic job and congratulations.” , Jose Le Roux (France) “I was taking a tour around Rosettacode and have found Ring. I like the syntax a lot. It’s clean and easy to understand. It looks like a very clean BASIC dialect without sigils. I can say that this is the easiest and the most BASIC-like language I’ve ever tried.” , Tomaaz “Thanks for this wonderful language” , Vinod kc (India) “Very enlightening. good job!” , Southmountain (United States) “The thing I liked was the loop exiting” , Leon de boer (Australia) “An outstanding and easy language to program with.” , Kenneth Burgo (Philippines) “I chose your language as I feel I can understand it better than other languages” , Harry Singh “I like the totality of the language, far more features than expected and the freedom of expressiveness is unique.” , Evikone 1.2 FetchStockData Application URL : https://groups.google.com/forum/#!topic/ring-lang/-fa1U_SXSjo Author : Bert Mariani This App is written in Ring. It will fetch stock data from Yahoo and draw various types of charts. Any valid stock ticker can be entered, or selected from the drop down list - Select Symbol. It will not guarantee that you make money in the stock market. But it will visualize the history of the stock. 1.2. FetchStockData Application 2
- 26. Ring Documentation, Release1.4.1 1.3 Fifteen Puzzle Game URL : https://github.com/CalmoSoft/CalmoSoft-Fifteen-Puzzle-Game/blob/gh-pages/CalmoSoftPuzzle.ring Author : Gal Zsolt (CalmoSoft) 1.4 TicTacToe Game URL : https://github.com/AbdelrahmanGIT/RingSamples/blob/master/src/TecTacToe.ring 1.3. Fifteen Puzzle Game 3
- 27. Ring Documentation, Release1.4.1 Author : Abdelrahman Mohammed 1.5 Squares Puzzle Game URL : https://github.com/MajdiSobain/RingAllegro_SquaresPuzzle Author : Majdi Sobain This project is about (Squares Puzzle) popular game that I have programmed using ring language with its RingAllegro Library. The principle of this game is very known to all of us, which is moving squares to get the real full shape of the original picture. This game could be played using mouse and keyboard as well, showing a message of congratulations at the successful solving. 1.5. Squares Puzzle Game 4
- 28. Ring Documentation, Release1.4.1 1.6 Analog Clock URL : https://github.com/ring-lang/ring/blob/master/applications/analogclock/AnalogClock-Image.ring Author : Bert Mariani 1.7 Werdy Application URL : http://werdy.info Source Code : https://github.com/magdy-ragab/werdy Author : Magdy Ragab 1.6. Analog Clock 5
- 29. Ring Documentation, Release1.4.1 Quran application includes reading suras, searching and bookmarking. The applcation is provided for Windows, Linux and Android. 1.8 Fifteen Puzzle Game 2 URL : https://github.com/ring-lang/ring/blob/master/applications/fifteenpuzzle/CalmoSoftFifteenPuzzleGame.ring Author : Gal Zsolt (CalmoSoft) 1.8. Fifteen Puzzle Game 2 6
- 30. Ring Documentation, Release1.4.1 1.9 Samples in this book The next samples are developed in little hours and we will introduce them through this book. The next screen shot for he Ring Notepad application 1.9. Samples in this book 7
- 31. Ring Documentation, Release1.4.1 The next screen shot for the Cards Game The next screen shot for the Cards Game (Android) 1.9. Samples in this book 8
- 32. Ring Documentation, Release1.4.1 The next screen shot from the Web Development chapter 1.9. Samples in this book 9
- 33. Ring Documentation, Release1.4.1 The next screen shots for simple 2D Games that we will present in the Game Engine Chapter. Stars Fighter Game Flappy Bird 3000 Game Super Man 2016 Game 1.9. Samples in this book 10
- 34. CHAPTER TWO INTRODUCTION Welcome to theRing programming language! The Ring is an Innovative and practical general-purpose multi-paradigm language that can be embedded in C/C++ projects, extended using C/C++ code and/or used as standalone language. The supported programming paradigms are Imperative, Procedural, Object-Oriented, Functional, Meta programming, Declarative programming using nested structures, and Natural programming. The language is portable (Windows, Linux, Mac OS X, Android, etc.) and can be used to create Console, GUI, Web, Games and Mobile applications. The language is designed to be Simple, Small, Flexible and Fast. Its Dynamic Language (Dynamic Typing and Weakly Typed) that compile the source code to byte code then execute it by the Ring Virtual Machine, which is integrated with the Ring Compiler in one program. In this chapter we are going to discuss the goals behind the language design and implementation. 2.1 Motivation In Nov. 2011, I started to think about creating a new version of the Programming Without Coding Technology (PWCT) software from scratch. I was interested in creating multi-platform edition of the software beside adding support for Web & Mobile develop- ment. Most of the PWCT source code was written in VFP and the software comes with a simple scripting language for creating the components called (RPWI). The software contains components that support code generation in pro- gramming languages like Harbour, C, Supernova & Python. What I was looking for is a programming language that can be used to build the development environment, provides multi-platform support, more productivity, better performance, can be used for components scripting & can be used for developing different kinds of applications. Instead of using a mix of programming languages, I decided to use one programming language for creating the devel- opment environment, for components scripting & for creating the applications. I looked at many programming languages like C, C++, Java, C#, Lua, PHP, Python & Ruby. I avoided using C or C++ directly because I want high-level of productivity more than the level provided by these languages, also a language behind visual programming environment for novice programmers or professionals must be easy to use & productive. 11
- 35. Ring Documentation, Release1.4.1 Java & C# are avoided for some reason too! I wanted to use a dynamic programming language and these languages are static typing, Java is multi-platform, also C# through Mono, but the use of huge number of classes and forcing the use of Object-Orientation, using a verbose language is not right for me. I need a small language, but fast and productive, also I need better control on the Garbage Collector (GC), I need a better one that is designed for fast applications. Lua is small and fast, but it’s avoided because I need more powerful language for large applications. PHP is a Web programming language and it’s syntax is very similar to C, this leads to a language not general as I want and not simple as I need to have. Python & Ruby are more like what I need, but I need something more simple, smaller, faster & productive. Python and Ruby are Case-Sensitive, the list index start counting from 0, you have to define the function before calling it, Ruby usage of Object-Orientation and message passing is more than what I need and decrease performance, Python syntax (indentation, using self, :, pass & _) is not good for my goals. All of these languages are successful languages, and very good for their domains, but what I need is a different language that comes with new ideas and intelligent implementation (Innovative, Ready, Simple, Small, Flexible and Fast). 2.2 History In Sept. 2013 I started the design and the implementation of the Ring programming language. After 21 months of development, In May 2015 the language Compiler & Virtual Machine were ready for use! After that I spent three months testing the language again, trying to discover any bug to fix, writing better tests, by the end of August 2015, all know bugs were fixed, Writing many tests and testing automation helped a lot in getting a stable product. In September 12, 2015, most of the documentation was written. Before releasing the language I started the marketing by writing a post in Arabic language about it to my facebook profile page asking for contributors interested in the language idea after reading a short description, In the same day I got a lot of emails from developers and friends interested to contribute! Ring 1.0 is released on January 25, 2016 Ring 1.1 is released on October 6, 2016 Ring 1.2 is released on January 25, 2017 Ring 1.3 is released on May 15, 2017 Ring 1.4 is released on June 29, 2017 Ring 1.4.1 is released on July 11, 2017 2.3 Features The Ring language comes with the next features Tip: The language is ready for production! • Free Open Source (MIT License) • Hybrid Implementation (Compiler + Virtual Machine) • Declarative programming on the top of Object-Oriented programming 2.2. History 12
- 36. Ring Documentation, Release1.4.1 • Natural Language programming on the top of Object-Oriented programming • Syntax Flexibility (You can change the language keywords and operators) • Compact Syntax, No explicit end for statements (No ; or ENTER is required) • Using braces { } we can access objects and use attributes/methods as variables/functions • Transparent Implementation • Visual Implementation - Developed using Visual Programming (PWCT) • A small language (Around 200,000 lines of code) – The compiler + The Virtual Machine are 15,000 lines of C code – The other 185,000 lines of code are related to libraries! • Writen in ANSI C (The code is generated) • Optional Printing for Tokens/Grammar/Byte-Code during execution • Portable (Windows, Linux & Mac OS X) • Comments (One line & Multi-lines) • Not Case-Sensitive • Dynamic Typing • Weakly typed • Lexical Scoping (Global, Local & Object State) • Default scope for variables inside functions (Local) • Default scope for variables outside functions (global) • Garbage Collector - Automatic Memory Management (Escape Analysis and Reference Counting) • Structure Programming • Rich control structures & Operators • For in get item by reference not value, you can read/edit the item • Use exit to go outside from more than one loop • Procedures/Functions • Main Function (optional) • Call Function before the definition • Recursion • Multi-line literals • Access (read/write) string letter by index • The list index start by 1 • No keyword to end Functions/Classes/Packages • Range operator ex: 1:10 and “a”:”z” • First Class Variables, Lists, Objects and Functions • Store/Copy Lists/Objects by value (Deep Copy) • Pass Lists/Objects by reference 2.3. Features 13
- 37. Ring Documentation, Release1.4.1 • Native Object-Oriented Support – Encapsulation – Setter/Getter (optional) – private state (optional) – Instantiation – Polymorphism – Composition – Inheritance (Single Inheritance) – Operator Overloading – Packages • Reflection and Meta-programming • Clear program structure (Statements then functions then packages & classes) • Exception Handling • Eval() to execute code during run-time • 8-bit clean, work on binary data directly • I/O commands • Math functions • String functions • List functions • File processing functions • Database support (ODBC, SQLite & MySQL) • Security Functions (OpenSSL) • Internet Functions (LibCurl) • Zip Functions • CGI Library (Written in Ring) – HTTP Get – HTTP Post – File upload – Cookies – URL Encode – HTML Templates – HTML Special Characters – HTML Generation using Functions – HTML Generation using Classes – CRUD Example (using MVC) – Users Example (Register, Login and Check) 2.3. Features 14
- 38. Ring Documentation, Release1.4.1 • Extension using C/C++ (Simple API) • Embedding the language in C/C++ programs • Comes with code generator (Written in Ring) to quickly wrap C/C++ Libraries – Used to Support Allegro by creating RingAllegro – Used to Support LibSDL by creating RingLibSDL – Used to Support Qt by creating RingQt • Create 2D Games for Desktop and Mobile (Using the Allegro Library or the LibSDL Library) • Comes with simple Game Engine for 2D Games • Create GUI Applications for Desktop and Mobile (Using the Qt Framework) • Comes with IDE contains the Code Editor (Ring Notepad) and the Form Designer 2.4 License The Ring Programming Language http://ring-lang.net/ Version 1.4.1 The MIT License (MIT) Copyright (c) Mahmoud Fayed Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documen- tation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PAR- TICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFT- WARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 2.4. License 15
- 39. CHAPTER THREE LANGUAGE DESIGN In thischapter we will learn about the basic concepts behind the language design. 3.1 Why Ring? The language is simple, trying to be natural, encourage organization and comes with transparent and visual implemen- tation. It comes with compact syntax and a group of features that enable the programmer to create natural interfaces and declarative domain-specific languages in a fraction of time. It is very small, fast and comes with smart garbage collector that puts the memory under the programmer control. It supports many programming paradigms, comes with useful and practical libraries. The language is designed for productivity and developing high quality solutions that can scale. 3.2 Designed for a Clear Goal • Applications programming language. • Productivity and developing high quality solutions that can scale. • Small and fast language that can be embedded in C/C++ projects. • Simple language that can be used in education and introducing Compiler/VM concepts. • General-Purpose language that can be used for creating domain-specific libraries, frameworks and tools. • Practical language designed for creating the next version of the Programming Without Coding Technology software. 3.3 Simple Ring is a very simple language, and has a very straightforward syntax. It encourages programmers to program without boilerplate code See "Hello, World!" The Main function is optional and will be executed after the statements, and is useful for using the local scope. Func Main See "Hello, World!" 16
- 40. Ring Documentation, Release1.4.1 Uses Dynamic Typing and Lexical scoping. No $ is required before the variable name! You can use the ‘+’ operator for string concatenation and the language is weakly typed and will convert automatically between numbers and strings based on the context. nCount = 10 # Global variable Func Main nID = 1 # Local variable See "Count = " + nCount + nl + " ID = " + nID 3.4 Trying to be natural Ring is not case-sensitive See "Enter your name ? " Give name See "Hello " + Name # Name is the same as name The list index starts from 1 aList = ["one","two","three"] See aList[1] # print one Call functions before definition one() two() three() Func one See "One" + nl Func two See "two" + nl Func three See "three" + nl The assignment operator uses Deep copy (no references in this operation) aList = ["one","two","three"] aList2 = aList aList[1] = 1 see alist[1] # print 1 see aList2[1] # print one Pass numbers and strings by value, but pass lists and objects by reference. The for in loop can update the list items. Func Main aList = [1,2,3] update(aList) see aList # print one two three Func update aList for x in aList switch x on 1 x = "one" on 2 x = "two" on 3 x = "three" off next 3.4. Trying to be natural 17
- 41. Ring Documentation, Release1.4.1 Using Lists during definition aList = [ [1,2,3,4,5] , aList[1] , aList[1] ] see aList # print 1 2 3 4 5 1 2 3 4 5 1 2 3 4 5 Exit from more than one loop for x = 1 to 10 for y = 1 to 10 see "x=" + x + " y=" + y + nl if x = 3 and y = 5 exit 2 # exit from 2 loops ok next next 3.5 Encourage Organization The language encourage organization, Forget bad days using languages where the programmer start with function then class then function and a strange mix between things! Each source file follow the next structure • Load Files • Statements and Global Variables • Functions • Packages and Classes This enable us to use Packages, Classes and Functions without the need to use a keyword to end these components. We can write one line comments and multi-line comments The comment starts with # or // Multi-line comments are written between /* and */ /* Program Name : My first program using Ring Date : 2015.05.08 */ See "What is your name? " # print message on screen give cName # get input from the user see "Hello " + cName # say hello! // See "Bye!" 3.6 Transparent Implementation Ring comes with transparent implementation. We can know what is happening in each compiler stage and what is going on during the run-time by the Virtual Machine Example : ring helloworld.ring -tokens -rules -ic See "Hello, World!" Output 3.5. Encourage Organization 18
- 42. Ring Documentation, Release1.4.1 ================================================================== Tokens - Generated by the Scanner ================================================================== Keyword : SEE Literal : Hello, World! EndLine ================================================================== ================================================================== Grammar Rules Used by The Parser ================================================================== Rule : Program --> {Statement} Line 1 Rule : Factor --> Literal Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr ================================================================== ================================================================== Byte Code - Before Execution by the VM ================================================================== PC OPCode Data 1 FuncExE 2 PushC Hello, World! 3 Print 4 ReturnNull ================================================================== Hello, World! 3.7 Visual Implementation The Ring programming language is designed using the PWCT visual programming tool and you will find the visual source of the language in the folder “visualsrc” - *.ssf files and the generated source code (In the C Language) in the src folder and the include folder. The next screen shot from the ring_vm.ssf file (Generate ring_vm.c and ring_vm.h) 3.7. Visual Implementation 19
- 43. Ring Documentation, Release1.4.1 The next screen shot from the ring_list.ssf file (Generate ring_list.c and ring_list.h) 3.8 Compact Syntax The language is not line sensitive, you don’t need to write ; after statements, also you don’t need to press ENTER or TAB, so we can write the next code See "The First Message" See " Another message in the same line! " + nl See "Enter your name?" Give Name See "Hello " + Name 3.8. Compact Syntax 20
- 44. Ring Documentation, Release1.4.1 The next code create a class called Point contains three attributes X,Y and Z. No keywords is used to end the pack- age/class/function definition. Also, we can write the attributes names directly below the class name. Class Point X Y Z We can use classes and functions before their definition, In this example we will create new object, set the object attributes then print the object values. o1 = New point o1.x=10 o1.y=20 o1.z=30 See O1 Class Point X Y Z Instead of using the dot ‘.’ operator to access the object attributes and methods we can use braces { } to access the object, then we can use the object attributes and methods. o1 = New point { x=10 y=20 z=30 } See O1 Class Point X Y Z Now we will call a method after accessing the object using { } oPerson = new Person { Name = "Somebody" Address = "Somewhere" Phone = "0000000" Print() # here we call the Print() method } Class Person Name Address Phone Func Print See "Name :" + name + nl + "Address :" + Address + nl + "Phone : " + phone + nl When we use { } to access the object then write any attribute name, the language will check the class for any set- ter/getter methods that will be called automatically. New Number { See one # Execute GetOne() See two # Execute GetTwo() See three # Execute GetThree() } Class Number one two three Func GetOne See "Number : One" + nl return 1 Func GetTwo See "Number : Two" + nl return 2 Func GetThree See "Number : Three" + nl return 3 3.9 Define Natural Statements After the object access using { } if the class contains a method called BraceEnd() it will be executed! TimeForFun = new journey # The first surprise! TimeForFun { Hello it is me # What a beatiful programming world! } 3.9. Define Natural Statements 21
- 45. Ring Documentation, Release1.4.1 # Our Class Class journey hello=0 it=0 is=0 me=0 func GetHello See "Hello" + nl func braceEnd See "Goodbye!" + nl We can execute code written in strings using the Eval() function cCode = "See 'Code that will be executed later!' " Eval(cCode) # execute the code to print the message We can create a list then execute code generated from that list aWords = ["hello","it","is","me"] for word in aWords cCode=word+"=0" eval(cCode) next We can read text files using the Read(cFileName) function and we can write files using the Write(cFileName,cString) function. See "Enter File Name:" Give cFileName See Read(cFileName) # Print the file content The next example presents how to create a class that defines two instructions The first instruction is : I want window The second instruction is : Window title = Expression Also keywords that can be ignored like the ‘the’ keyword New App { I want window The window title = "hello world" } Class App # Attributes for the instruction I want window i want window nIwantwindow = 0 # Attributes for the instruction Window title # Here we don't define the window attribute again title nWindowTitle = 0 # Keywords to ignore, just give them any value the=0 func geti if nIwantwindow = 0 nIwantwindow++ ok func getwant if nIwantwindow = 1 nIwantwindow++ ok func getwindow if nIwantwindow = 2 nIwantwindow= 0 see "Instruction : I want window" + nl ok 3.9. Define Natural Statements 22
- 46. Ring Documentation, Release1.4.1 if nWindowTitle = 0 nWindowTitle++ ok func settitle cValue if nWindowTitle = 1 nWindowTitle=0 see "Instruction : Window Title = " + cValue + nl ok To complete the previous example, use read() to get the content of a file that contains I want window The window title = "hello world" Then use eval() to execute the content of that file!. Also, you can update the methods GetWindow() and SetTitle() to create Real windows using the GUI Library 3.10 Define Declarative Languages We learned how to use Natural statements to execute our code and using the same features we can use nested structures to execute our code. The next example from the Web library, generate HTML document using the Bootstrap library. No HTML code is written directly in this example, we created a similar language (just as example) Then using this declarative language that uses nested structures, we generated the HTML Document.. The idea in this example is that the GetDiv() and GetH1() methods return an object that we can access using {} and after each object access the method BraceEnd() will be executed to send the generated HTML to the parent object until we reach to the root where BraceEnd() will print the output. Load "weblib.ring" Import System.Web Func Main BootStrapWebPage() { div { classname = :container div { classname = :jumbotron H1 { text("Bootstrap Page") } } div { classname = :row for x = 1 to 3 div { classname = "col-sm-4" H3 { html("Welcome to the Ring programming language") } P { html("Using a scripting language is very fun!") } } next } 3.10. Define Declarative Languages 23
- 47. Ring Documentation, Release1.4.1 } } The classes that power the declarative interface looks like this Class Link from ObjsBase title link Func braceend cOutput = nl+GetTabs() + "<a href='" + Link + "'> "+ Title + " </a> " + nl Class Div from ObjsBase Func braceend cOutput += nl+'<div' addattributes() AddStyle() getobjsdata() cOutput += nl+"</div>" + nl cOutput = TabMLString(cOutput) 3.11 Smart Garbage Collector Avoid memory problems :- • Invalid Memory Access • Memory leaks • Uninitialized Memory Access • Dangling pointer Rules :- • Global variables always stay in the memory, until you delete these variables using the assignment statement. • Local variables always deleted after the end of the function. • The programmer have full control on when to delete the variable from the memory using the Assignment state- ment. Example: aList = [1,2,3,4,5] aList = "nice" After the second line directly, The list [1,2,3,4,5] will be deleted from the memory and we will have a string “nice” • The programmer can call the function callgc() to force running the garbage collector. • If we have a reference to a variable (when we pass objects and lists to functions), then deleting variables will be based on reference counting, if no references everything will be deleted, but if we have a reference, the data will stay in memory. 3.11. Smart Garbage Collector 24
- 48. CHAPTER FOUR WHAT IS NEWIN RING 1.4.1? In this chapter we will learn about the changes in Ring 1.4.1 release. Ring 1.4.1 is a little update to Ring 1.4 4.1 List of changes and new features Ring 1.4.1 comes with the next changes • Better Scripts for Building from Source Code • Better Colors for the Modern Style in Ring Notepad • Better StdLib • Better RingQt • New Sample : Sixteen Puzzle 4.2 Better Scripts for Building from Source Code The scripts are updated for building from source code. Tested using Windows, Ubuntu Linux, Linux Mint and MacOS X. Screen Shot: 25
- 49. Ring Documentation, Release1.4.1 4.3 Better Colors for the Modern Style in Ring Notepad In Ring Notepad - the (Modern) Style colors are updated Screen Shot: 4.3. Better Colors for the Modern Style in Ring Notepad 26
- 50. Ring Documentation, Release1.4.1 4.4 Better StdLib The StdLib is updated to include the next functions • TrimLeft() • TrimRight() • TrimAll() • EpochTime() 4.5 Better RingQt The next functions are updated to display the dialogs on the top of other windows. • SetDialogIcon(cIconFile) • MsgInfo(cTitle,cMessage) • ConfirmMsg(cTitle,cMessage) • InputBox(cTitle,cMessage) • InputBoxInt(cTitle,cMessage) • InputBoxNum(cTitle,cMessage) • InputBoxPass(cTitle,cMessage) 4.6 New Sample : Sixteen Puzzle The Sixteen Puzzle is added to the Applications folder. Screen Shot: 4.4. Better StdLib 27
- 51. Ring Documentation, Release1.4.1 4.6. New Sample : Sixteen Puzzle 28
- 52. CHAPTER FIVE WHAT IS NEWIN RING 1.4? In this chapter we will learn about the changes and new features in Ring 1.4 release. 5.1 List of changes and new features Ring 1.4 comes with many new features • Change: Basic Extensions are separated from RingVM • The Natural Library • New Style is added to Ring Notepad • RingREPL • Convert between Numbers and Bytes • Better StdLib • Better WebLib • Better RingQt • Qt Class Convertor 5.2 Change: Basic Extensions are separated from RingVM In Ring 1.4 the next libraries are separated from RingVM • RingODBC • RingMySQL • RingSQLite • RingOpenSSL • RingInternet To use these libraries, Use the Load command. load "odbclib.ring" # use ODBC Functions load "mysqllib.ring" # use MySQL Functions 29
- 53. Ring Documentation, Release1.4.1 load "sqlitelib.ring" # use SQLite Functions load "openssllib.ring" # use OpenSSL Functions ( Hash and Security functions) load "internetlib.ring" # use Internet Functions ( Download() and SendEmail() ) If you will use all of these libraries, You can just use stdlib.ring And the stdlib.ring will load odbclib.ring, mysqllib.ring, sqlitelib.ring, opensslib.ring and internetlib.ring files. load "stdlib.ring" 5.3 The Natural Library Ring 1.4 comes with the Natural Library to quickly define a language that contains a group of commands. We will write the natural code in a Text file, for example program.txt File: program.txt Welcome to the Ring programming language! What you are reading now is not comments, I swear! After many years of programming I decided to think different about programming and solve the problems in a better way. We are writing commands or code and the Ring language is reading it to understand us! Sure, What you are seeing now is just ***part of the code - Not the Complete Program*** You have to write little things before and after this part to be able to run it! It is the natural part of our code where we can write in English, Arabic or any Natural Language Then we will tell the computer through the Ring language what must happens! in a way that we can scale for large frameworks and programs. Just imagine what will happens to the world of programming once we create many powerful frameworks using the Ring language that uses this way (Natural Programming). For example When we say Hello to the Machine, It can reply! and when we say count from 1 to 5 it will understand us, Also if we said count from 5 to 1 it will understand us too! You can see the Output window! This Goal is not new, but the Ring language comes with an innovative solution to this problem. Output: Hello, Sire! The Numbers! 5.3. The Natural Library 30
- 54. Ring Documentation, Release1.4.1 1 2 3 4 5 I will count Again! 5 4 3 2 1 To execute the natural code, We have start.ring In start.ring we define the language and the commands. File: start.ring load "stdlib.ring" load "naturallib.ring" New NaturalLanguage { SetLanguageName(:MyLanguage) SetCommandsPath(CurrentDir()+"/../command") SetPackageName("MyLanguage.Natural") UseCommand(:Hello) UseCommand(:Count) RunFile("program.txt") } We defined a language called MyLanguage, We have folder for the language commands. Each command will define a class that belong to the MyLanguage.Natural package. We will define two commands, Hello and Count. So we must have two files for defining the commands in the CurrentDir()+”/../command” folder File: hello.ring DefineNaturalCommand.SyntaxIsKeyword([ :Package = "MyLanguage.Natural", :Keyword = :hello, :Function = func { See "Hello, Sire!" + nl + nl } ]) File: count.ring 5.3. The Natural Library 31
- 55. Ring Documentation, Release1.4.1 DefineNaturalCommand.SyntaxIsKeywordNumberNumber([ :Package = "MyLanguage.Natural", :Keyword = :count, :Function = func { if not isattribute(self,:count_times) { AddAttribute(self,:count_times) Count_Times = 0 } if Expr(1) > Expr(2) { nStep = -1 else nStep = 1 } if Count_Times = 0 { see nl+"The Numbers!" + nl Count_Times++ else see nl + "I will count Again!" +nl } for x = Expr(1) to Expr(2) step nStep { see nl+x+nl } CommandReturn(fabs(Expr(1)-Expr(2))+1) } ]) 5.4 New Style is added to Ring Notepad In Ring Notepad - From View - Styles - Select the (Modern) Style Screen Shot: 5.4. New Style is added to Ring Notepad 32
- 56. Ring Documentation, Release1.4.1 5.5 RingREPL In the application folder, You will find RingREPL (Read-Eval-Print-Loop) Also you can run it from Ring Notepad (Menubar - Tools) Screen Shot: 5.6 Convert between Numbers and Bytes Ring 1.4 comes with the next functions to convert between Numbers and Bytes. • Int2Bytes() • Float2Bytes() • Double2Bytes() • Bytes2Int() • Bytes2Float() 5.5. RingREPL 33
- 57. Ring Documentation, Release1.4.1 • Bytes2Double() Example: see "Test Int2Bytes() and Bytes2Int() - Value : 77" + nl r = Int2Bytes(77) see "Int Size : " + len(r) + nl see r + nl see Bytes2Int(r) + nl see "Test Float2Bytes() and Bytes2Float() - Value 77.12" + nl r = Float2Bytes(77.12) see "Float Size : " + len(r) + nl see r + nl see Bytes2Float(r) + nl see "Test Double2Bytes() and Bytes2Double() - Value 9999977.12345" + nl r = Double2Bytes(9999977.12345) see "Double Size : " + len(r) + nl see r + nl decimals(5) see Bytes2Double(r) + nl 5.7 Better StdLib The StdLib is updated to include the next functions • FSize() The print() function is updated to accept local variables. load "stdlib.ring" func main print("Enter your name : ") ; Name = getString() ; print( "Hello : #{Name} ") ; return ; 5.8 Better WebLib The web library is updated • Provide better error message 1. Error (WebLib-1) : REQUEST_METHOD is empty ! - Run this script from the browser 2. Error (DataLib-1) : Can’t connect to the database server! • Better Template() function - can accept NULL instead of object as the second paramter. html(template("main.rhtml",NULL)) • The Form Class is updated to support the “target” attribute. BootStrapWebPage() { Title = "The Ring Programming Language" html(template("main.rhtml",NULL)) 5.7. Better StdLib 34
- 58. Ring Documentation, Release1.4.1 div { classname = :container div { id = "div3" color = "black" backgroundcolor = "white" width = "100%" form { method = "POST" Action = website Target = "codeoutput" input { type="hidden" name="page" value=1 } Table { style = stylewidth("100%") + stylegradient(3) TR { TD { align="center" WIDTH="10%" text("Code :") } TD { html(` <textarea name = "cCode" rows="5" style="width : 100%; "> See "Hello, World!" + nl </textarea>`) } } } Input { type = "submit" classname="btn btn-primary btn-block" value = "Execute" } Table { style = stylewidth("100%") + stylegradient(34) TR { TD { align="center" WIDTH="10%" text("Output :") } TD { html(` <iframe name="codeoutput" width="100%" style="background-color:white;"> </iframe>`) } } } 5.8. Better WebLib 35
- 59. Ring Documentation, Release1.4.1 } } } html(template("footer.rhtml",NULL)) } 5.9 Better RingQt The next functions are added to RingQt • SetDialogIcon(cIconFile) • MsgInfo(cTitle,cMessage) • ConfirmMsg(cTitle,cMessage) • InputBox(cTitle,cMessage) • InputBoxInt(cTitle,cMessage) • InputBoxNum(cTitle,cMessage) • InputBoxPass(cTitle,cMessage) The next classes are added to RingQt • QToolButton • QSerialPort • QSerialPortInfo 5.10 Qt Class Convertor Ring 1.4 comes with a simple tool that help in porting Qt classes to RingQt. You will find it in ring/samples/tools/QtClassConverter Online : https://github.com/ring-lang/ring/tree/master/samples/tools/QtClassConverter Screen Shot: 5.9. Better RingQt 36
- 60. Ring Documentation, Release1.4.1 5.10. Qt Class Convertor 37
- 61. CHAPTER SIX WHAT IS NEWIN RING 1.3? In this chapter we will learn about the changes and new features in Ring 1.3 release. 6.1 List of changes and new features Ring 1.3 comes with many new features • Better RingQt • Better Ring Notepad • Ring mode for Emacs Editor • Better StdLib • Better Loop/Exit Command • New Functions • Return Self by Reference • Using ‘<’ and ‘:’ operators as ‘from’ keyword • Embedding Ring in Ring without sharing the State • RingZip Library • Form Designer 6.2 Better RingQt (1) Another version of QPixMap class is added (QPixMap2) which takes (int width,int height) during object init. Example: Load "guilib.ring" New qapp { win1 = new qwidget() { setwindowtitle("Drawing using QPixMap") setgeometry(100,100,500,500) label1 = new qlabel(win1) { setgeometry(10,10,400,400) settext("") 38
- 62. Ring Documentation, Release1.4.1 } imageStock = new qlabel(win1) { image = new qPixMap2(200,200) color = new qcolor() { setrgb(255,255,255,255) } pen = new qpen() { setcolor(color) setwidth(10) } new qpainter() { begin(image) setpen(pen) drawline(0,0,200,200) drawline(200,0,0,200) endpaint() } setpixmap(image) } show() } exec() } Screen Shot: 6.2. Better RingQt 39
- 63. Ring Documentation, Release1.4.1 2. The Objects Library is updated to include the next functions • Last_WindowID() • Open_WindowNoShow() • Open_WindowAndLink() Also the class name (WindowViewBase) is changed to (WindowsViewParent). In The next code for example the Open_WindowAndLink() will create an object from the SecondWindowController Class Then will add the Method SecondWindow() to the FirstWindowController Class Also will add the Method FirstWindow() to the SecondWindowController Class So the SendMessage() method in FirstWindowController class can use the SecondWindow() method to access the object. class firstwindowController from windowsControllerParent oView = new firstwindowView func OpenSecondWindow Open_WindowAndLink(:SecondWindowController,self) 6.2. Better RingQt 40
- 64. Ring Documentation, Release1.4.1 func SendMessage if IsSecondWindow() SecondWindow().setMessage("Message from the first window") ok func setMessage cMessage oView.Label1.setText(cMessage) 3. The next classes are added to RingQt • QPixMap2 • QScrollArea • QSplitter • QCompleter • QCompleter2 • QCompleter3 • QProcess • QMdiArea • QMdiSubWindow • QCursor • QListView • QDesktopServices 4. Many constants are defined in qt.rh (loaded by guilib.ring) 5. New Classes names - Index Start from 1 We added new classes to RingQt - another version of classes where the class names doesn’t start with the “q” letter Also updated methods so the index start from 1 when we deal with the GUI controls like • ComboBox • ListWidget • TableWidget • TreeWidget These classes are inside guilib.ring under the package name : System.GUI To use it load "guilib.ring" import System.GUI This doesn’t have any effect on our previous code, It’s just another choice for better code that is consistent with Ring rules. Also the form designer is updated to provide us the choice between using classes where (index start from 0) or (index start from 1) Example (Uses the Form Designer) 1. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/indexstart/indexstartView.ring 6.2. Better RingQt 41
- 65. Ring Documentation, Release1.4.1 2. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/indexstart/indexstartController.ring 6.3 Better Ring Notepad 1. Using QPlainTextEdit instead of QTextEdit 2. Displaying the line number for each line in the source code file. Screen Shot: 3. Auto-Complete for Ring functions names, classes and words in the opened file. 6.3. Better Ring Notepad 42
- 66. Ring Documentation, Release1.4.1 4. Functions and Methods List 6.3. Better Ring Notepad 43
- 67. Ring Documentation, Release1.4.1 5. Output Window 6. Classes List 6.3. Better Ring Notepad 44
- 68. Ring Documentation, Release1.4.1 7. Change the Current Style 6.4 Ring mode for Emacs Editor Ring 1.3 comes with Ring mode for Emacs Editor Screen Shot: 6.4. Ring mode for Emacs Editor 45
- 69. Ring Documentation, Release1.4.1 6.5 Better StdLib The StdLib is updated to include the next functions • SplitMany() • JustFilePath() • JustFileName() 6.6 Better Loop|Exit Command The Loop|Exit command is updated to accept Expressions after the command (not only numbers). The syntax: Loop|Exit [Number] Changed to Loop|Exit [Expression] Example XLoop = 2 # The outer loop YLoop = 1 # The first inner loop for x = 1 to 10 for y = 1 to 10 see "x=" + x + " y=" + y + nl if x = 3 and y = 5 exit XLoop ok 6.5. Better StdLib 46
- 70. Ring Documentation, Release1.4.1 next next 6.7 New Functions • PackageName() function • Swap() function Example: aList = [:one,:two,:four,:three] see aList see copy("*",50) + nl swap(aList,3,4) see aList Output one two four three ************************************************** one two three four 6.8 Return Self by Reference In this release, using Return Self in class methods will return the object by reference. Example: mylist = [new mytest() { see self x = 20 see self }] see mylist class mytest x = 15 func init return self # Return by reference Output x: 15.000000 x: 20.000000 x: 20.000000 6.7. New Functions 47
- 71. Ring Documentation, Release1.4.1 6.9 Using ‘<’ and ‘:’ operators as ‘from’ keyword In this release of the Ring language we can use the ‘<’ and ‘:’ operators as the ‘from’ keyword Syntax (1): class Cat from Animal Syntax (2): class Cat < Animal Syntax (3): class Cat : Animal 6.10 Embedding Ring in Ring without sharing the State From Ring 1.0 we already have functions for embedding Ring in the C language. Also we can execute Ring code inside Ring programs using the eval() function. In this release we provide functions for embedding Ring in Ring programs without sharing the state. Advantages: 1. Quick integration for Ring programs and applications together without conflicts. 2. Execute and run Ring code in safe environments that we can trace. Example: pState = ring_state_init() ring_state_runcode(pState,"See 'Hello, World!'+nl") ring_state_runcode(pState,"x = 10") pState2 = ring_state_init() ring_state_runcode(pState2,"See 'Hello, World!'+nl") ring_state_runcode(pState2,"x = 20") ring_state_runcode(pState,"see x +nl") ring_state_runcode(pState2,"see x +nl") v1 = ring_state_findvar(pState,"x") v2 = ring_state_findvar(pState2,"x") see v1[3] + nl see V2[3] + nl ring_state_delete(pState) ring_state_delete(pState2) Output: Hello, World! Hello, World! 10 20 10 20 6.9. Using ‘<’ and ‘:’ operators as ‘from’ keyword 48
- 72. Ring Documentation, Release1.4.1 6.11 RingZip Library Ring 1.3 comes with the RingZip library for creating, modifying and extracting *.zip files. Example (1): Create myfile.zip contains 4 files load "ziplib.ring" oZip = zip_openfile("myfile.zip",'w') zip_addfile(oZip,"test.c") zip_addfile(oZip,"zip.c") zip_addfile(oZip,"zip.h") zip_addfile(oZip,"miniz.h") zip_close(oZip) Example (2): Extract myfile.zip to myfolder folder. load "ziplib.ring" zip_extract_allfiles("myfile.zip","myfolder") Example (3): Print file names in the myfile.zip load "ziplib.ring" oZip = zip_openfile("myfile.zip",'r') for x=1 to zip_filescount(oZip) see zip_getfilenamebyindex(oZip,x) + nl next zip_close(oZip) Example (4) : Using Classes instead of Functions load "ziplib.ring" new Zip { SetFileName("myfile.zip") Open("w") AddFile("test.c") AddFile("zip.c") AddFile("zip.h") AddFile("miniz.h") Close() } 6.12 Form Designer Ring 1.3 comes with the Form Designer to quickly design your GUI application windows/forms and generate the Ring source code. It’s written in Ring (Around 8000 Lines of code) using Object-Oriented Programming and Meta-Programming. We can run the From Designer from Ring Notepad 6.11. RingZip Library 49
- 73. Ring Documentation, Release1.4.1 Also we can run the Form Designer in another window. 6.12. Form Designer 50
- 74. CHAPTER SEVEN WHAT IS NEWIN RING 1.2? In this chapter we will learn about the changes and new features in Ring 1.2 release. 7.1 List of changes and new features Ring 1.2 comes with many new features • New Functions • Better Functions • Better Ring Notepad • Better RingQt • Objects Library for RingQt • RingLibCurl • Better Call Command • Using NULL instead of NULLPointer() • Display Warnings Option • Better Quality 7.2 New Functions • PtrCmp() Function is a new function that compare between C pointers like the GUI objects. • PrevFileName() Function is added to return the previous active source file name. • RingVM_CFunctionsList() Function is added to return a list of functions written in C. • RingVM_FunctionsList() Function is added to return a list of functions written in Ring. • RingVM_ClassesList() Function is added to return a list of Classes. • RingVM_PackagesList() Function is added to return a list of Packages. • RingVM_MemoryList() Function is added to return a list of Memory Scopes and Variables. • RingVM_CallList() Function is added to return a list of the functions call list. • RingVM_FilesList() Function is added to return a list of the Ring Files. Example: 51
- 75. Ring Documentation, Release1.4.1 fp = fopen("ptrcmp.ring","r") fp2 = fp fp3 = fopen("ptrcmp.ring","r") see ptrcmp(fp,fp2) + nl see ptrcmp(fp,fp3) + nl fclose(fp) fclose(fp3) Output: 1 0 Also we can compare between them using the ‘=’ operator Example: fp = fopen("ptrcmp2.ring","r") fp2 = fopen("ptrcmp2.ring","r") fp3 = fp see fp = fp2 see nl see fp = fp3 fclose(fp) fclose(fp2) Output: 0 1 Example: The next function in stdlib.ring uses the PrevFileName() to know if the file of the caller function is the main source file of the program or not. Func IsMainSourceFile if PrevFileName() = sysargv[2] return true ok return false 7.3 Better Functions The find() function is updated to support searching in lists using C pointers like GUI Objects. The type() function is updated to display the C pointers types (like the GUI Object Class Name). 7.4 Better Ring Notepad The Ring Notepad will save the current line number of opened files to be restored when we switch between files. Also Ring Notepad will ask the user to save the file if the file content is changed when the user switch between files. 7.3. Better Functions 52
- 76. Ring Documentation, Release1.4.1 7.5 Better RingQt RingQt classes are updated to include methods to get events (The code that will be executed when an event is fired). This is necessary to enable/disable events for some time or to get the events information. For example the next code disable an event then call a method then enable the event again. cEvent = oView.oListResult.getCurrentItemChangedEvent() oView.oListResult.setCurrentItemChangedEvent("") FindValueAction() # Call Method while an event is disabled oView.oListResult.setCurrentItemChangedEvent(cEvent) Also the QAllEvents class is updated where we can set the output from the event function to be true or false using a new method added to the class called setEventOutput. Load "guilib.ring" MyApp = New qApp { win = new qWidget() { setwindowtitle("Hello World") setGeometry(100,100,370,250) lineedit1 = new qlineedit(win) { setGeometry(10,100,350,30) setinputmask("9999;_") oFilter = new qallevents(lineedit1) oFilter.setfocusoutEvent("pMove()") installeventfilter(oFilter) } lineedit2 = new qlineedit(win) { setGeometry(10,150,350,30) } show() } exec() } func pMove win.setWindowTitle("xxxx") oFilter.setEventOutput(False) 7.6 Objects Library for RingQt Ring 1.2 comes with the Objects library for RingQt applications. Instead of using global variables for windows objects and connecting events to objects using the object name, the Objects Library will manage the GUI objects and will provide a more natural API to quickly create one or many windows from the same class and the library provide a way to quickly set methods to be executed when an event is fired. Also the library provide a natural interface to quickly use the parent or the caller windows from the child or sub windows. The Objects Library is designed to be used with the MVC Design Pattern. The Objects Library is merged in RingQt so you can use it directly when you use RingQt Example : load "guilib.ring" new qApp { 7.5. Better RingQt 53
- 77. Ring Documentation, Release1.4.1 open_window( :MainWindowController ) exec() } class MainWindowController from WindowsControllerParent oView = new MainWindowView func SubWindowAction Open_window( :SubWindowController ) Last_Window().SetParentObject(self) class MainWindowView from WindowsViewParent win = new qWidget() { SetWindowTitle("Main Window") btnSub = new qPushButton(win) { setText("Sub Window") setClickEvent( Method( :SubWindowAction ) ) } resize(400,400) } class SubWindowController from WindowsControllerParent oView = new SubWindowView func SetMainWindowTitleAction Parent().oView.win.SetWindowTitle("Message from the Sub Window") oView.win.SetWindowTitle("Click Event Done!") class SubWindowView from WindowsViewParent win = new qWidget() { SetWindowTitle("Sub Window") btnMsg = new qPushButton(win) { setText("Set Main Window Title") setClickEvent( Method( :SetMainWindowTitleAction ) ) } btnClose = new qPushButton(win) { Move(200,0) setText("Close") setClickEvent( Method( :CloseAction ) ) } resize(400,400) } 7.7 RingLibCurl The LibCurl library is used starting from Ring 1.0 for the Download() and SendEmail() functions implementation. In Ring 1.2 more functions are added to provide a powerful library (RingLibCurl) around LibCurl. Example: load "libcurl.ring" curl = curl_easy_init() cPostThis = "page=4&Number1=4&Number2=5" curl_easy_setopt(curl, CURLOPT_URL, "http://localhost/ringapp/index.ring?page=3") curl_easy_setopt(curl, CURLOPT_POSTFIELDS, cPostThis) 7.7. RingLibCurl 54
- 78. Ring Documentation, Release1.4.1 curl_easy_perform(curl) curl_easy_cleanup(curl) 7.8 Better Call Command The Call command is updated to support calling functions from object attributes also (not only variables). For example the next code from the Stars Fighter Game cFunc = oself.keypress call cFunc(oGame,oSelf,Key_Space) Can be written in one line call oself.keypress(oGame,oSelf,Key_Space) 7.9 Using NULL instead of NULLPointer() We can pass NULL to functions instead of using NULLPointer() For example the next code from RingLibSDL SDL_RenderCopy(SDL_ren,tex,NULLPointer(),rect) Can be written as in the next line SDL_RenderCopy(SDL_ren,tex,NULL,rect) 7.10 Display Warnings Option In Ring 1.2 the Ring compiler is updated to include the Display Warnings option (-w) Example: load "stdlib.ring" load "stdlib.ring" compiling the program using the Display Warnings option will display the file duplication warning, While without that option the error will pass silent. This is a warning (not an error) because in large projects you may use the same file more than one time. For example it’s common to start each file with the next code. where the function IsMainSourceFile() is part from the stdlib.ring load "stdlib.ring" if IsMainSourceFile() // Testing ok 7.8. Better Call Command 55
- 79. Ring Documentation, Release1.4.1 7.11 Better Quality Ring 1.2 is more stable, We discovered and fixed more bugs during Ring usage everyday in practical projects. Some functions are optimized to be faster like the SubStr() function. Also the documentation is more better. 7.11. Better Quality 56
- 80. CHAPTER EIGHT WHAT IS NEWIN RING 1.1? In this chapter we will learn about the changes and new features in Ring 1.1 release. 8.1 List of changes and new features Ring 1.1 comes with many new features • Better Natural Language Programming Support • Generate/Execute Ring Object Files (*.ringo) • Syntax Flexibility and different styles for I/O and Control Structures • New Functions and Changes • StdLib functions and classes written in Ring • RingLibSDL • Demo Project - Game Engine for 2D Games • RingSQLite • Better Code Generator for Extensions • Using Self.Attribute in the Class Region to define new attributes • Using This.Attribute in nested Braces inside the Class Methods • Better Documentation 8.2 Better Natural Language Programming Support Ring is an innovative language because of it’s compact syntax, smart implementation (small, transparent & visual) and it’s ability to create declarative and natural domain specific languages in a fraction of time. This release add support for calling methods when an expression is evaluated check this example: # Natural Code new program { Accept 2 numbers then print the sum } # Natural Code Implementation 57
- 81. Ring Documentation, Release1.4.1 class program # Keywords Accept=0 numbers=0 then=0 print=0 the=0 sum=0 # Execution func braceexpreval x value = x func getnumbers for x=1 to value see "Enter Number ("+x+") :" give nNumber aNumbers + nNumber next func getsum nSUm = 0 for x in aNumbers nSum+= x next see "The Sum : " + nSum private value=0 aNumbers=[] Output: Enter Number (1) :3 Enter Number (2) :4 The Sum : 7 for more information see the “Natural Language Programming” chapter. 8.3 Generate/Execute Ring Object Files (*.ringo) This feature enable you to distribute your applications without distributing the source code. Also it makes application distribution a simple process where you get one Ring object file for the complete project (many source code files). Also using Ring object file remove the loading time required for compiling the application. Check the “command line options” chapter to know more about this feature. 8.4 Syntax Flexibility and different styles for I/O and Control Struc- tures Programmers are sensitive to the programming language syntax. Great programmers know how to work using many different styles but each programmer may have his/her favorite style. Each programming language comes with a style that you may like or not. Ring is just one of these languages, but as a response to many programmers asking for a better syntax we decided to provide more options. Also some of these features are very necessary for Natural Language Programming. Example : We have two commands to change language keywords and operators. ChangeRingOperator + plus ChangeRingKeyword see print Print 5 plus 5 8.3. Generate/Execute Ring Object Files (*.ringo) 58
- 82. Ring Documentation, Release1.4.1 ChangeRingOperator plus + ChangeRingKeyword print see We have new styles (Optional) for Input/Output. Example : Put "What is your name? " Get cName Put "Hello " + cName Example : Load "stdlib.ring" Print("What is your name? ") # print message on screen cName=GetString() # get input from the user print("Hello #{cName}") # say hello! We have new styles (optional) for control structures. Example : While True Put " Main Menu --------- (1) Say Hello (2) About (3) Exit " Get nOption Switch nOption Case 1 Put "Enter your name : " Get name Put "Hello " + name + nl Case 2 Put "Sample : using while loop" + nl Case 3 Bye Else Put "bad option..." + nl End End Example : Load "stdlib.ring" While True { print(" Main Menu --------- (1) Say Hello (2) About (3) Exit 8.4. Syntax Flexibility and different styles for I/O and Control Structures 59
- 83. Ring Documentation, Release1.4.1 ") nOption = GetString() switch nOption { case 1 print("Enter your name : ") name = getstring() print("Hello #{name}n") case 2 print("Sample : using switch statementn") case 3 Bye else print("bad option...n") } } Check the next chapters:- • Getting Started - Second Style • Getting Started - Third Style • Control Structures - Second Style - May looks like Lua and Ruby • Control Structures - Third Style - May looks like C (uses braces) • Syntax Flexibility Note: All of these styles are provided automatically by the compiler at the same time, It’s better to select one style for the same project (you can create your style as a mix from these styles) for example you can use Put/Get and Braces. 8.5 New Functions and Changes Changed: • get() function : changed to sysget() • sort() function : can now work on list of objects • find() function : can now work on list of objects Added: • clockspersecond() • CurrentDir() • ExeFileName() • ChDir() • ExeFolder() • varptr() • space() • nullpointer() 8.5. New Functions and Changes 60
- 84. Ring Documentation, Release1.4.1 • object2pointer() • pointer2object() Check the next chapters • System Functions • Object Oriented Programming (OOP) • Low Level Functions 8.6 StdLib functions and classes written in Ring Ring 1.1 comes with a library called StdLib, it’s written in Ring by the help of Ring Team The library provide a useful group of new functions and classes Example: Load "stdlib.ring" Puts("Test Times()") Times ( 3 , func { see "Hello, World!" + nl } ) Example: Load "stdlib.ring" Puts("Test Map()") See Map( 1:10, func x { return x*x } ) Example: Load "stdlib.ring" Puts("Test Filter()") See Filter( 1:10 , func x { if x <= 5 return true else return false ok } ) Example: Load "stdlib.ring" See "Testing the String Class" + nl oString = new string("Hello, World!") oString.println() oString.upper().println() oString.lower().println() oString.left(5).println() oString.right(6).println() Example: Load "stdlib.ring" oList = new list ( [1,2,3] ) oList.Add(4) oList.print() Example: 8.6. StdLib functions and classes written in Ring 61
- 85. Ring Documentation, Release1.4.1 Load "stdlib.ring" oStack = new Stack oStack.push(1) oStack.push(2) oStack.push(3) see oStack.pop() + nl Example: Load "stdlib.ring" oQueue = new Queue oQueue.add(1) oQueue.add(2) oQueue.add(3) see oQueue.remove() + nl Example: Load "stdlib.ring" ohashtable = new hashtable See "Test the hashtable Class Methods" + nl ohashtable { Add("Egypt","Cairo") Add("KSA","Riyadh") see self["Egypt"] + nl see self["KSA"] + nl see contains("Egypt") + nl see contains("USA") + nl see index("KSA") + NL print() delete(index("KSA")) see copy("*",60) + nl print() } Example: Load "stdlib.ring" otree = new tree See "Test the tree Class Methods" + nl otree { set("The first step") # set the root node value see value() + nl Add("one") Add("two") Add("three") { Add("3.1") Add("3.2") Add("3.3") see children } see children oTree.children[2] { Add("2.1") Add("2.2") Add("2.3") { Add("2.3.1") Add("2.3.2") Add("test") 8.6. StdLib functions and classes written in Ring 62
- 86. Ring Documentation, Release1.4.1 } } oTree.children[2].children[3].children[3].set("2.3.3") } see copy("*",60) + nl oTree.print() Check the next chapters: • StdLib Functions • StdLib Classes 8.7 RingLibSDL Ring 1.0 provided RingAllegro to be able to create games using the Allegro game programming library Now Ring 1.1 provide RingLibSDL also so we can have the choice between Allegro or LibSDL Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) SDL_Delay(2000) SDL_DestroyWindow(win) SDL_Quit() See the RingLibSDL Chapter. 8.8 Demo Project - Game Engine for 2D Games In practice we would create a game engine in a language like C/C++ to get the best performance then provide Ring classes to use the engine. But many 2D Games are simple and creating a game engine in Ring will be fast enough in many cases Also this would be a good demo project to learn about the language concepts where we build things using Object Ori- ented Programming (OOP) then access the power that we have using declarative programming using nested structures or using natural programming. In this project we selected the first way (declarative programming using nested structures) Example: Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" text { x = 10 y=50 animate = false size = 20 8.7. RingLibSDL 63
- 87. Ring Documentation, Release1.4.1 file = "fonts/pirulen.ttf" text = "game development using ring is very fun!" color = rgb(0,0,0) # Color = black } text { x = 10 y=150 # Animation Part ====================================== animate = true # Use Animation direction = GE_DIRECTION_INCVERTICAL # Increase y point = 400 # Continue until y=400 nStep = 3 # Each time y+= 3 #====================================================== size = 20 file = "fonts/pirulen.ttf" text = "welcome to the real world!" color = rgb(0,0,255) # Color = Blue } Sound { # Play Sound file = "sound/music1.wav" # Sound File Name } } # Start the Events Loop See the “Demo Project - Game Engine for 2D Games” chapter. 8.9 RingSQLite Ring 1.0 provided support for ODBC to use any database and provided native support for MySQL. Now Ring 1.1 provide native support for SQLite database too. Example: oSQLite = sqlite_init() sqlite_open(oSQLite,"mytest.db") sql = "CREATE TABLE COMPANY(" + "ID INT PRIMARY KEY NOT NULL," + "NAME TEXT NOT NULL," + "AGE INT NOT NULL," + "ADDRESS CHAR(50)," + "SALARY REAL );" sqlite_execute(oSQLite,sql) sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (1, 'Mahmoud', 29, 'Jeddah', 20000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (2, 'Ahmed', 27, 'Jeddah', 15000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (3, 'Mohammed', 31, 'Egypt', 20000.00 );" + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (4, 'Ibrahim', 24, 'Egypt ', 65000.00 );" sqlite_execute(oSQLite,sql) aResult = sqlite_execute(oSQLite,"select * from COMPANY") 8.9. RingSQLite 64
- 88. Ring Documentation, Release1.4.1 for x in aResult for t in x see t[2] + nl next next see copy("*",50) + nl for x in aResult see x["name"] + nl next sqlite_close(oSQLite) 8.10 Better Code Generator for Extensions We are using the code generator (written in Ring) every day to add new libraries to Ring. The generator is used to create RingQt and RingAllegro Also in Ring 1.1 it’s used to create RingLibSDL. more features are added like • Set/Get structure members (numbers & pointers) • Using constants • Better Generated Code See the Code Generator chapter. 8.11 Using Self.Attribute in the Class Region to define new attributes We can use Self.Attribute in the Class Region (after the class name and before any methods) to define new attributes. class Person name # Define name as attribute if it's not a global variable address phone class person2 self.name # Must Define the attribute self.address self.phone 8.12 Using This.Attribute in nested Braces inside the Class Methods We can use nested braces {} while we are inside methods to access another objects, In this case the current object scope will be changed while we are inside the brace and Self will point to the object that we access using braces {}. In this case we can use This.Attribute and This.Method() to access the object that will be created from the current class. Check the Object Oriented Programming chapter for more information. Also Check the Weight History Application in GUI Development using RingQt chapter. 8.10. Better Code Generator for Extensions 65
- 89. Ring Documentation, Release1.4.1 8.13 Better Documentation Ring 1.1 documentation (800 pages) is better than Ring 1.0 documentation (340 pages) Many chapters are added for providing better information about the language like • Language Reference • Scope Rules • FAQ And more! 8.13. Better Documentation 66
- 90. CHAPTER NINE BUILDING FROM SOURCECODE The Ring programming language is a free open source product (MIT License). You can build Ring using CMake or using Scripts (Batch Files or Shell Scripts). The next steps explains building using scripts. 9.1 Building using Microsoft Windows Get the source code git clone http://github.com/ring-lang/ring.git Build Ring (Compiler/VM) cd ring/src buildvccomplete.bat buildvccompletew.bat Build RingODBC cd ../extensions/ringodbc buildvc.bat Build RingMySQL cd ../extensions/ringmysql buildvc.bat Build RingSQLite cd ../extensions/ringsqlite buildvc.bat Build RingOpenSSL cd ../extensions/ringopenssl buildvc.bat Build RingInternet cd ../extensions/ringinternet buildvc.bat Generate RingAllegro Source Code and Build 67
- 91. Ring Documentation, Release1.4.1 cd ../extensions/ringallegro gencode.bat buildvc.bat Generate RingLibCurl Source Code and Build cd ../extensions/ringcurl gencode.bat buildvc.bat Generate RingZip Source Code and Build cd ../extensions/ringzip gencode.bat buildvc.bat Install Qt 5.5 : https://download.qt.io/archive/qt/5.5/5.5.1/ Generate RingQt Source Code and Build cd ../ringqt gencode.bat buildmingw32.bat To be able to call ring from any folder cd ../../bin install.bat Add Ring/bin to System path Hit "windows key". Type "Edit the System environment variables" Select "Advanced" tab. Click on "Enviroment Variables..." Double click on "Path" Add at the end the new path separated by semicolon. ;C:RingBin Run Ring Notepad cd applications/rnote ring rnote.ring 9.2 Building using Ubuntu Linux Get the source code git clone http://github.com/ring-lang/ring.git Install Libraries cd ring/src ./installdep.sh Build Ring (Compiler/VM) sudo ./buildgcccomplete.sh 9.2. Building using Ubuntu Linux 68
- 92. Ring Documentation, Release1.4.1 Build RingODBC cd ../extensions/ringodbc ./buildgcc.sh Build RingMySQL cd ../extensions/ringmysql ./buildgcc.sh Build RingSQLite cd ../extensions/ringsqlite ./buildgcc.sh Build RingOpenSSL cd ../extensions/ringopenssl ./buildgcc.sh Build RingInternet cd ../extensions/ringinternet ./buildgcc.sh Generate RingAllegro Source Code and Build cd ../extensions/ringallegro ./gencode.sh ./buildgcc.sh Generate RingLibCurl Source Code and Build cd ../extensions/ringcurl ./gencode.sh ./buildgcc.sh Generate RingZip Source Code and Build cd ../extensions/ringzip ./gencode.sh ./buildgcc.sh Generate RingQt Source Code and Build cd ../ringqt ./gencode.sh ./buildgcc.sh To be able to call ring from any folder cd ../../bin sudo ./install.sh Run Ring Notepad cd applications/rnote ring rnote.ring 9.2. Building using Ubuntu Linux 69
- 93. Ring Documentation, Release1.4.1 9.3 Building using MacOS X Get the source code git clone http://github.com/ring-lang/ring.git Install homebrew (follow the directions on homebrew’s homepage). Install Libraries brew install unixodbc mysql-connector-c allegro openssl homebrew/versions/qt55 brew link --force qt55 Build Ring (Compiler/VM) cd ring/src ./buildclangcomplete.sh Build RingODBC cd ../extensions/ringodbc ./buildclang.sh Build RingMySQL cd ../extensions/ringmysql ./buildclang.sh Build RingSQLite cd ../extensions/ringsqlite ./buildclang.sh Build RingOpenSSL cd ../extensions/ringopenssl ./buildclang.sh Build RingInternet cd ../extensions/ringinternet ./buildclang.sh Generate RingAllegro Source Code and Build cd ../extensions/ringallegro ./gencode.sh ./buildclang.sh Generate RingLibCurl Source Code and Build cd ../extensions/ringcurl ./gencode.sh ./buildclang.sh Generate RingZip Source Code and Build cd ../extensions/ringzip ./gencode.sh ./buildclang.sh Generate RingQt Source Code and Build 9.3. Building using MacOS X 70
- 94. Ring Documentation, Release1.4.1 cd ../ringqt ./gencode.sh ./buildclang.sh To be able to call ring from any folder cd ../../bin sudo ./install.sh Run Ring Notepad cd applications/rnote sudo ring rnote.ring 9.4 Building using CMake Install libraries (MySQL Client, OpenSSL, LibCurl, Allegro 5 and Qt 5.5) cmake . make 9.4. Building using CMake 71
- 95. CHAPTER TEN HOW TO CONTRIBUTE? Ringis a free-open source project, Everyone is welcome to contribute to Ring. Project Home : https://github.com/ring-lang/ring You can help in many parts in the project • Documentation • Testing • Samples • Applications • Editors Support • Libraries in Ring • Extensions in C/C++ • Compiler and Virtual Machine (VM) • Ideas and suggestions 10.1 Special thanks to contributors Throughout the creation of this project, Ring relied heavily on contributions from experts along with college students. Their input was invaluable, and we want to take a moment to thank them and recognize them for all of their hard work. Ring Team: http://ring-lang.sf.net/team.html 10.2 Documentation You can modify anything in the documentation, by updating the text files (*.txt) in this folder : https://github.com/ring- lang/ring/tree/master/docs/source The documentation is created using Sphinx : http://www.sphinx-doc.org/en/stable/ 10.3 Testing You can write new tests in this folder https://github.com/ring-lang/ring/tree/master/tests/scripts 72
- 96. Ring Documentation, Release1.4.1 10.4 Samples You can add new samples to this folder https://github.com/ring-lang/ring/tree/master/samples/other 10.5 Applications You can add new applications to this folder https://github.com/ring-lang/ring/tree/master/applications 10.6 Editors Support You can help in supporting Ring in different code editors Check the next folder https://github.com/ring-lang/ring/tree/master/editor 10.7 Libraries in Ring You can update and add libraries to this folder https://github.com/ring-lang/ring/tree/master/ringlibs 10.8 Extensions in C/C++ You can add and update extensions in this folder https://github.com/ring-lang/ring/tree/master/extensions 10.9 Compiler and Virtual Machine (VM) • Source Code (C Language) : https://github.com/ring-lang/ring/tree/master/src • Visual Source (PWCT) : https://github.com/ring-lang/ring/tree/master/visualsrc 10.10 Ideas and suggestions You can share your ideas, suggestions and questions in this group https://groups.google.com/forum/#!forum/ring-lang 10.4. Samples 73
- 97. CHAPTER ELEVEN GETTING STARTED -FIRST STYLE 11.1 Hello World The next program prints the Hello World message on the screen (std-out). see "Hello World" 11.2 Run the program to run the program, save the code in a file, for example : hello.ring then from the command line or terminal, run it using the ring interpreter ring hello.ring 11.3 Not Case-Sensitive Since the Ring language is not case-sensitive, the same program can be written in different styles Tip: It’s better to select one style and use it in all of the program source code SEE "Hello World" See "Hello World" 11.4 Multi-Line literals Using Ring we can write multi-line literal, see the next example See " Hello Welcome to the Ring programming language How are you? " Also you can use the nl constant to insert new line and you can use the + operator to concatenate strings 74
- 98. Ring Documentation, Release1.4.1 Note: nl value means a new line and the actual codes that represent a newline is different between operating systems See "Hello" + nl + "Welcome to the Ring programming language" + nl + "How are you?" 11.5 Getting Input You can get the input from the user using the give command See "What is your name? " Give cName See "Hello " + cName 11.6 No Explicit End For Statements You don’t need to use ‘;’ or press ENTER to separate statements. The previous program can be written in one line. See "What is your name? " give cName see "Hello " + cName 11.7 Writing Comments We can write one line comments and multi-line comments The comment starts with # or // Multi-lines comments are written between /* and */ /* Program Name : My first program using Ring Date : 2016.09.09 Author : Mahmoud Fayed */ See "What is your name? " # print message on screen give cName # get input from the user see "Hello " + cName # say hello! // See "Bye!" Note: Using // to comment a lines of code is just a code style. 11.5. Getting Input 75
- 99. CHAPTER TWELVE GETTING STARTED -SECOND STYLE 12.1 Hello World The next program prints the Hello World message on the screen (std-out). put "Hello World" 12.2 Run the program to run the program, save the code in a file, for example : hello.ring then from the command line or terminal, run it using the ring interpreter ring hello.ring 12.3 Not Case-Sensitive Since the Ring language is not case-sensitive, the same program can be written in different styles Tip: It’s better to select one style and use it in all of the program source code PUT "Hello World" Put "Hello World" 12.4 Multi-Line literals Using Ring we can write multi-line literal, see the next example Put " Hello Welcome to the Ring programming language How are you? " Also you can use the nl constant to insert new line and you can use the + operator to concatenate strings 76
- 100. Ring Documentation, Release1.4.1 Note: nl value means a new line and the actual codes that represent a newline is different between operating systems Put "Hello" + nl + "Welcome to the Ring programming language" + nl + "How are you?" 12.5 Getting Input You can get the input from the user using the get command Put "What is your name? " Get cName Put "Hello " + cName 12.6 No Explicit End For Statements You don’t need to use ‘;’ or press ENTER to separate statements. The previous program can be written in one line. Put "What is your name? " get cName put "Hello " + cName 12.7 Writing Comments We can write one line comments and multi-line comments The comment starts with # or // Multi-lines comments are written between /* and */ /* Program Name : My first program using Ring Date : 2016.09.09 Author : Mahmoud Fayed */ Put "What is your name? " # print message on screen get cName # get input from the user put "Hello " + cName # say hello! // Put "Bye!" Note: Using // to comment a lines of code is just a code style. 12.5. Getting Input 77
- 101. CHAPTER THIRTEEN GETTING STARTED -THIRD STYLE 13.1 Hello World The next program prints the Hello World message on the screen (std-out). load "stdlib.ring" print("Hello World") 13.2 Run the program to run the program, save the code in a file, for example : hello.ring then from the command line or terminal, run it using the ring interpreter ring hello.ring 13.3 Not Case-Sensitive Since the Ring language is not case-sensitive, the same program can be written in different styles Tip: It’s better to select one style and use it in all of the program source code LOAD "stdlib.ring" PRINT("Hello World") Load "stdlib.ring" Print("Hello World") 13.4 Multi-Line literals Using Ring we can write multi-line literal, see the next example Load "stdlib.ring" Print(" Hello Welcome to the Ring programming language How are you? 78
- 102. Ring Documentation, Release1.4.1 ") Also you can use the n to insert new line and you can use #{variable_name} to insert variables values. Load "stdlib.ring" Print( "HellonWelcome to the Ring programming languagenHow are you?") 13.5 Getting Input You can get the input from the user using the getstring() function Load "stdlib.ring" Print("What is your name? ") cName = GetString() Print("Hello #{cName}") 13.6 No Explicit End For Statements You don’t need to use ‘;’ or press ENTER to separate statements. The previous program can be written in one line. Load "stdlib.ring" Print("What is your name? ") cName=getstring() print("Hello #{cName}") 13.7 Writing Comments We can write one line comments and multi-line comments The comment starts with # or // Multi-lines comments are written between /* and */ /* Program Name : My first program using Ring Date : 2016.09.09 Author : Mahmoud Fayed */ Load "stdlib.ring" Print("What is your name? ") # print message on screen cName=GetString() # get input from the user print("Hello #{cName}") # say hello! // print("Bye!") Note: Using // to comment a lines of code is just a code style. 13.5. Getting Input 79
- 103. CHAPTER FOURTEEN USING RING NOTEPAD Inthis chapter we will learn about using Ring Notepad to write and execute Ring programs quickly Ring Notepad is just a simple application developed using the Ring language. 14.1 Ring Notepad - Main Window When we run the Ring Notepad we get the next dockable windows • Project Files Window : where we can select and open any ring file (*.ring) quickly. • Source Code Window : Where we write the source code. • Form Designer Window : The Form Designer to create GUI application forms. • Web Browser Window : Where we read the documentation or quickly open any website. • Output Window : Output when we run programs that print to the standard output • Function Window : List of functions in the current source file • Classes Window : List of classes in the current source file 80
- 104. Ring Documentation, Release1.4.1 14.2 Creating and running your first Console Application At first we will type the source code See "Hello, World!" As in the next image Then we will click on the “Save” button from the toolbar (or press CTRL+S) Determine the source code file name and location. For example type : hello This will create a new source code file called : hello.ring 14.2. Creating and running your first Console Application 81
- 105. Ring Documentation, Release1.4.1 To run the program click on “Debug (Run then wait!)” button from the toolbar The next screen shot present the application during the runtime Press Enter to continue and return to the Ring Notepad. 14.2. Creating and running your first Console Application 82
- 106. Ring Documentation, Release1.4.1 14.3 Creating and running your first GUI/Mobile Application To learn how to create GUI applications using Ring check the “Desktop and Mobile development using RingQt” chapter. Source Code: Load "guilib.ring" New qApp { new qWidget() { resize(400,400) setWindowTitle("Hello, World!") show() } exec() } In Ring notepad we have a special button to run GUI applications without displaying the console window. 14.3. Creating and running your first GUI/Mobile Application 83
- 107. Ring Documentation, Release1.4.1 The next screen shot present the application during the runtime 14.4 Creating and running your first Web Application To learn how support Ring in your web server and how to create web applications using Ring check the “Web Devel- opment (CGI Library)” chapter. Note: You need to support the Ring language in your web server to be able to run the next example. Source Code: 14.4. Creating and running your first Web Application 84
- 108. Ring Documentation, Release1.4.1 #!b:ringbinring.exe -cgi load "weblib.ring" Import System.Web new page { text("Hello, World!") } We can run the application in any web browser or in the browser that are embedded in Ring Notepad. 14.5 Creating and running your first Desktop/Mobile Game To learn about creating 2D Games using Ring check the “Demo Project - Game Engine for 2D Games” chapter. Source Code: Load "gameengine.ring" func main oGame = New Game { title = "My First Game" sprite { type = GE_TYPE_PLAYER x=400 y=400 width=100 height=100 file = "images/player.png" transparent = true Animate=false 14.5. Creating and running your first Desktop/Mobile Game 85
- 109. Ring Documentation, Release1.4.1 Move=true Scaled=true } } We can run the application as any GUI application. 14.5. Creating and running your first Desktop/Mobile Game 86
- 110. CHAPTER FIFTEEN USING OTHER CODEEDITORS In the Ring/Editor folder you will find extensions for the next editors • Notepad++ • Geany • Atom • Sublime Text 2 • Visual Studio IDE • Emacs 15.1 Using Notepad++ Folder : ring/editor/notepad_plus_plus • Open Notepad++ • Open the “Language” menu • Select “Define your language...” • Click “Import...” • select Ring.xml • Select “OK” on the “Import successful” dialog and close the “User Defined Language” dialog/panel • You may need to restart notepad++ 87
- 111. Ring Documentation, Release1.4.1 15.2 Using Geany Folder : ring/editor/geany • Run Geany editor • Click on “Tools -> configuration files -> filetypes_extensions.conf” menu • Add this line “Ring=*.ring;” without quotes after [Extensions] • In unbuntu copy file “filetypes.Ring.conf” to folder “/home/USERNAME/filetypes.Ring.conf” • You can run your files by pressing F5 button 15.2. Using Geany 88
- 112. Ring Documentation, Release1.4.1 15.3 Using Atom Folder : ring/editor/atom Just Copy the folder atom-language-ring to the next path "C:Users{UserName}.atomPackages" 15.3. Using Atom 89
- 113. Ring Documentation, Release1.4.1 15.4 Using Sublime Text 2 Folder : ring/editor/sublime text 2 In the folder Sublime_Text_2 you will find the next three files 1 - ring.json-tmlanguage 2 - ring.sublime-build 3 - ring.tmlanguage Just Copy the files to the next path "C:Users{UserName}AppDataRoamingSublime Text 2PackagesUser" The file ring.sublime-build includes the next line "cmd": ["B:ringbinring.exe","$file"], You can modify it according to the ring.exe path in your machine 15.4. Using Sublime Text 2 90
- 114. Ring Documentation, Release1.4.1 15.5 Using Visual Studio IDE Folder : ring/editor/visualstudio Check the ReadMe file for installation instructions. 15.5. Using Visual Studio IDE 91
- 115. Ring Documentation, Release1.4.1 15.6 Using Emacs Editor Folder : ring/editor/emacs Check the ReadMe file for installation instructions. Screen Shot: 15.6. Using Emacs Editor 92
- 116. CHAPTER SIXTEEN VARIABLES To create anew variable, you just need to determine the variable name & value. The value will determine the variable type and you can change the value to switch between the types using the same variable name. Syntax: <Variable Name> = <Value> Tip: The operator ‘=’ is used here as an Assignment operator and the same operator can be used in conditions, but for testing equality of expressions. Note: The Variable will contains the real value (not a reference). This means that once you change the variable value, the old value will be removed from memory (even if the variable contains a list or object). 16.1 Dynamic Typing Ring is a dynamic programming language that uses Dynamic Typing. x = "Hello" # x is a string see x + nl x = 5 # x is a number (int) see x + nl x = 1.2 # x is a number (double) see x + nl x = [1,2,3,4] # x is a list see x # print list items x = date() # x is a string contains date see x + nl x = time() # x is a string contains time see x + nl x = true # x is a number (logical value = 1) see x + nl x = false # x is a number (logical value = 0) see x + nl 16.2 Deep Copy We can use the assignment operator ‘=’ to copy variables. We can do that to copy values like strings & numbers. Also, we can copy complete lists & objects. The assignment operator will do a complete duplication for us. This operation called Deep Copy 93
- 117. Ring Documentation, Release1.4.1 list = [1,2,3,"four","five"] list2 = list list = [] See list # print the first list - no items to print See "********" + nl See list2 # print the second list - contains 5 items 16.3 Weakly Typed Ring is a weakly typed language, this means that the language can automatically convert between data types (like string & numbers) when that conversion make sense. Rules: <NUMBER> + <STRING> --> <NUMBER> <STRING> + <NUMBER> --> <STRING> Note: The same operator ‘+’ can be used as an arithmetic operator or for string concatenation. Example: x = 10 # x is a number y = "20" # y is a string sum = x + y # sum is a number (y will be converted to a number) Msg = "Sum = " + sum # Msg is a string (sum will be converted to a string) see Msg + nl 16.3. Weakly Typed 94
- 118. CHAPTER SEVENTEEN OPERATORS In this chapterwe will introduce the operators provided by the Ring programming langauge. 17.1 Arithmetic Operators The next table presents all of the arithmetic operators provided by the Ring language. Assume variable X=50 and variable Y=10 then: Operator Description Example Result + Add x+y 60 - Subtract x-y 40 * Multiplies x*y 500 / Divide x/y 5 % Modulus x%y 0 ++ Increment x++ 51 - - Decrement x- - 49 17.2 Relational Operators The next table presents all of the relational operators provided by the Ring language. Assume variable X=50 and variable Y=10 then: Operator Description Example Result = Equal x = y False != Not Equal x != y True > Greater than x > y True < Less than x < y False >= Greater or Equal x >= y True <= Less than or Equal x <= y False 17.3 Logical Operators The next table presents all of the logical operators provided by the Ring language. Assume variable X=True and variable Y=False then: Operator Description Example Result and Logical AND x and y False or Logical OR x or y True not Logical Not not x False 95
- 119. Ring Documentation, Release1.4.1 17.4 Bitwise Operators The next table presents all of the bitwise operators provided by the Ring language. Assume variable X=8 and variable Y=2 then: Operator Description Example Result & Binary AND x & y 0 | Binary OR x | y 10 ^ Binary XOR x ^ y 10 ~ Binary Ones Complement ~x -9 << Binary Left Shift x << y 32 >> Binary Right Shift x >> y 2 17.5 Assignment Operators The next table presents all of the assignment operators provided by the Ring language. Assume variable X=8 then: Operator Description Example Result = Assignment x = 10 x=10 += Add AND assignment x += 5 x=13 -= Subtract AND assignment x -= 3 x=5 *= Multiply AND assignment x *= 2 x=16 /= Divide AND assignment x /= 3 x=2.67 %= Modulus AND assignment x %= 2 x=0 <<= Left shift AND assignment x <<= 2 x=32 >>= Right shift AND assignment x >>= 2 x=2 &= Bitwise AND assignment x &= 4 x=0 |= Bitwise OR and assignment x |= 3 x=11 ^= Bitwise XOR and assignment x ^= 4 x=12 17.6 Misc Operators Operator Description :literal using : before identifier mean literal Start:End create list contains items from start to end [list items] define list items list[index] access list item obj.name using the dot operator to access object members (attributes/methods). obj {stmts} execute statements with direct access to object attributes & methods func(para,...) call function using parameters separated by comma 17.7 Operators Precedence The next table present operators from higher precedence (Evaluated first) to lower precedence. 17.4. Bitwise Operators 96
- 120. Ring Documentation, Release1.4.1 Operator . [] () {} - ~ :Literal [list items] ++ - - Start:End * / % + - << >> & | ^ < > <= >= = != not and or Assignment = += -= *= /= %=>>= <<= &= ^= |= Example: See 3+5*4 # prints 23 17.7. Operators Precedence 97
- 121. CHAPTER EIGHTEEN CONTROL STRUCTURES -FIRST STYLE In this chapter we are going to learn about the control structures provided by the Ring programming language. 18.1 Branching • If Statement Syntax: if Expression Block of statements but Expression Block of statements else Block of statements ok Example: see " Main Menu --------- (1) Say Hello (2) About (3) Exit " give nOption if nOption = 1 see "Enter your name : " give name see "Hello " + name + nl but nOption = 2 see "Sample : using if statement" + nl but nOption = 3 bye else see "bad option..." + nl ok • Switch Statement Syntax: switch Expression on Expression Block of statements other Block of statements off 98
- 122. Ring Documentation, Release1.4.1 Example: See " Main Menu --------- (1) Say Hello (2) About (3) Exit " Give nOption Switch nOption On 1 See "Enter your name : " Give name See "Hello " + name + nl On 2 See "Sample : using switch statement" + nl On 3 Bye Other See "bad option..." + nl Off 18.2 Looping • While Loop Syntax: while Expression Block of statements end Example: While True See " Main Menu --------- (1) Say Hello (2) About (3) Exit " Give nOption Switch nOption On 1 See "Enter your name : " Give name See "Hello " + name + nl On 2 See "Sample : using while loop" + nl On 3 Bye Other See "bad option..." + nl Off End • For Loop Syntax: 18.2. Looping 99
- 123. Ring Documentation, Release1.4.1 for identifier=expression to expression [step expression] Block of statements next Example: # print numbers from 1 to 10 for x = 1 to 10 see x + nl next Example: # Dynamic loop See "Start : " give nStart See "End : " give nEnd See "Step : " give nStep For x = nStart to nEnd Step nStep see x + nl Next Example: # print even numbers from 0 to 10 for x = 0 to 10 step 2 see x + nl next Example: # print even numbers from 10 to 0 for x = 10 to 0 step -2 see x + nl next • For in Loop Syntax: for identifier in List/String [step expression] Block of statements next Example: aList = 1:10 # create list contains numbers from 1 to 10 for x in aList see x + nl next # print numbers from 1 to 10 18.3 Using The Step option with For in We can use the Step option with For in to skip number of items in each iteration Example: aList = 1:10 # create list contains numbers from 1 to 10 # print odd items inside the list for x in aList step 2 see x + nl next 18.3. Using The Step option with For in 100
- 124. Ring Documentation, Release1.4.1 18.4 Using For in to modify lists When we use (For in) we get items by reference. This means that we can read/edit items inside the loop. Example: aList = 1:5 # create list contains numbers from 1 to 5 # replace list numbers with strings for x in aList switch x on 1 x = "one" on 2 x = "two" on 3 x = "three" on 4 x = "four" on 5 x = "five" off next see aList # print the list items 18.5 Do Again Loop Syntax: do Block of statements again expression Example: x = 1 do see x + nl x++ again x <= 10 18.6 Exit Command Used to go outside one or more of loops. Syntax: exit [expression] # inside loop Example: for x = 1 to 10 see x + nl if x = 5 exit ok next 18.4. Using For in to modify lists 101
- 125. Ring Documentation, Release1.4.1 18.7 Exit from two loops The next example presents how to use the exit command to exit from two loops in one jump. Example: for x = 1 to 10 for y = 1 to 10 see "x=" + x + " y=" + y + nl if x = 3 and y = 5 exit 2 # exit from 2 loops ok next next • Loop Command Used to jump to the next iteration in the loop. Syntax: loop [expression] # inside loop Example: for x = 1 to 10 if x = 3 see "Number Three" + nl loop ok see x + nl next 18.8 Exit/Loop inside sub functions While we are inside a loop, we can call a function then use the exit and/or loop command inside that function and the command will work on the outer loop. Example: # print numbers from 1 to 10 except number 5. for x = 1 to 10 ignore(x,5) see x + nl next func ignore x,y if x = y loop ok 18.9 Short-circuit evaluation The logical operators and/or follow the short-circuit evaluation. 18.7. Exit from two loops 102
- 126. Ring Documentation, Release1.4.1 If the first argument of the AND operator is zero, then there is no need to evaluate the second argument and the result will be zero. If the first argument of the OR operator is one, then there is no need to evaluate the second argument and the result will be one. Example: /* output ** nice ** nice ** great */ x = 0 y = 10 if (x = 0 and nice()) and (y = 10 and nice()) see "great" + nl ok func nice see "nice" + nl return 1 Example: # No output x = 0 y = 10 if (x = 1 and nice()) and (y = 10 and nice()) see "great" + nl ok func nice see "nice" + nl return 1 Example: /* output ** nice ** great */ x = 0 y = 10 if (x = 0 and nice()) or (y = 10 and nice()) see "great" + nl ok func nice see "nice" + nl return 1 18.10 Comments about evaluation • True, False, nl & NULL are variables defined by the language • True = 1 • False = 0 • nl = new line • NULL = empty string = “” 18.10. Comments about evaluation 103
- 127. Ring Documentation, Release1.4.1 • Everything evaluates to true except 0 (False). Example: # output = message from the if statement if 5 # 5 evaluates to true because it's not zero (0). see "message from the if statement" + nl ok 18.10. Comments about evaluation 104
- 128. CHAPTER NINETEEN CONTROL STRUCTURES -SECOND STYLE In this chapter we are going to learn about the second style of control structures provided by the Ring programming language. 19.1 Branching • If Statement Syntax: if Expression Block of statements elseif Expression Block of statements else Block of statements end Example: put " Main Menu --------- (1) Say Hello (2) About (3) Exit " get nOption if nOption = 1 put "Enter your name : " get name put "Hello " + name + nl elseif nOption = 2 put "Sample : using if statement" + nl elseif nOption = 3 bye else put "bad option..." + nl end • Switch Statement Syntax: switch Expression case Expression Block of statements else Block of statements end 105
- 129. Ring Documentation, Release1.4.1 Example: Put " Main Menu --------- (1) Say Hello (2) About (3) Exit " Get nOption Switch nOption Case 1 Put "Enter your name : " Get name Put "Hello " + name + nl Case 2 Put "Sample : using switch statement" + nl Case 3 Bye Else Put "bad option..." + nl End 19.2 Looping • While Loop Syntax: while Expression Block of statements end Example: While True Put " Main Menu --------- (1) Say Hello (2) About (3) Exit " Get nOption Switch nOption Case 1 Put "Enter your name : " Get name Put "Hello " + name + nl Case 2 Put "Sample : using while loop" + nl Case 3 Bye Else Put "bad option..." + nl End End • For Loop Syntax: 19.2. Looping 106
- 130. Ring Documentation, Release1.4.1 for identifier=expression to expression [step expression] Block of statements end Example: # print numbers from 1 to 10 for x = 1 to 10 put x + nl end Example: # Dynamic loop Put "Start : " get nStart Put "End : " get nEnd Put "Step : " get nStep For x = nStart to nEnd Step nStep Put x + nl End Example: # print even numbers from 0 to 10 for x = 0 to 10 step 2 Put x + nl end Example: # print even numbers from 10 to 0 for x = 10 to 0 step -2 put x + nl end • For in Loop Syntax: for identifier in List/String [step expression] Block of statements end Example: aList = 1:10 # create list contains numbers from 1 to 10 for x in aList put x + nl end # print numbers from 1 to 10 19.3 Exceptions try Block of statements catch Block of statements end 19.3. Exceptions 107
- 131. CHAPTER TWENTY CONTROL STRUCTURES -THIRD STYLE In this chapter we are going to learn about the third style of control structures provided by the Ring programming language. 20.1 Branching • If Statement Syntax: if Expression { Block of statements elseif Expression Block of statements else Block of statements } Example: Load "stdlib.ring" print(" Main Menu --------- (1) Say Hello (2) About (3) Exit ") nOption = getnumber() if nOption = 1 { print("Enter your name : ") name = getstring() print("Hello #{name}n") elseif nOption = 2 print("Sample : using if statementn") elseif nOption = 3 bye else print("bad option...n") } 108
- 132. Ring Documentation, Release1.4.1 • Switch Statement Syntax: switch Expression { case Expression Block of statements else Block of statements } Example: Load "stdlib.ring" print(" Main Menu --------- (1) Say Hello (2) About (3) Exit ") nOption = GetString() switch nOption { case 1 print("Enter your name : ") name = getstring() print("Hello #{name}n") case 2 print("Sample : using switch statementn") case 3 Bye else print("bad option...n") } 20.2 Looping • While Loop Syntax: while Expression { Block of statements } Example: Load "stdlib.ring" While True { print(" Main Menu --------- 20.2. Looping 109
- 133. Ring Documentation, Release1.4.1 (1) Say Hello (2) About (3) Exit ") nOption = GetString() switch nOption { case 1 print("Enter your name : ") name = getstring() print("Hello #{name}n") case 2 print("Sample : using switch statementn") case 3 Bye else print("bad option...n") } } • For Loop Syntax: for identifier=expression to expression [step expression] { Block of statements } Example: # print numbers from 1 to 10 load "stdlib.ring" for x = 1 to 10 { print("#{x}n") } Example: load "stdlib.ring" # Dynamic loop print("Start : ") nStart = getnumber() print("End : ") nEnd = getnumber() print("Step : ") nStep = getnumber() for x = nStart to nEnd step nStep { print("#{x}n") } Example: load "stdlib.ring" # print even numbers from 0 to 10 for x = 0 to 10 step 2 { print("#{x}n") } 20.2. Looping 110
- 134. Ring Documentation, Release1.4.1 Example: load "stdlib.ring" # print even numbers from 10 to 0 for x = 10 to 0 step -2 { print("#{x}n") } • For in Loop Syntax: for identifier in List/String [step expression] { Block of statements } Example: load "stdlib.ring" aList = 1:10 # create list contains numbers from 1 to 10 for x in aList { print("#{x}n") } # print numbers from 1 to 10 Example: load "stdlib.ring" aList = 1:10 # create list contains numbers from 1 to 10 # print odd items inside the list for x in aList step 2 { print("#{x}n") } When we use (For in) we get items by reference. This means that we can read/edit items inside the loop. Example: load "stdlib.ring" aList = 1:5 # create list contains numbers from 1 to 5 # replace list numbers with strings for x in aList { switch x { case 1 x = "one" case 2 x = "two" case 3 x = "three" case 4 x = "four" case 5 x = "five" } } print(aList) # print the list items 20.3 Exceptions 20.3. Exceptions 111
- 135. Ring Documentation, Release1.4.1 try { Block of statements catch Block of statements } 20.3. Exceptions 112
- 136. CHAPTER TWENTYONE GETTING INPUT We canget input from the keyboard using • The Give Command • The GetChar() Function • The Input() Function 21.1 Give Command Syntax: Give VariableName Example: See "Enter the first number : " Give nNum1 See "Enter the second number : " Give nNum2 See "Sum : " + ( 0 + nNum1 + nNum2 ) Output: Enter the first number : 3 Enter the second number : 4 Sum : 7 21.2 GetChar() Function We can get one character from the standard input using the GetChar() function Syntax: GetChar() ---> Character Example: While True See " Main Menu (1) Say Hello (2) Exit " Option = GetChar() 113
- 137. Ring Documentation, Release1.4.1 GetChar() GetChar() # End of line # the previous two lines can be replaced with the next line # Give Option if Option = 1 see "Enter your name : " give cName see "Hello " + cName else bye ok End 21.3 Input() Function We can get input from the keyboard using the Input() function Syntax: Input(nCount) ---> string The function will wait until nCount characters (at least) are read Example: See "Enter message (30 characters) : " cMsg = input(30) See "Message : " + cMsg 21.3. Input() Function 114
- 138. CHAPTER TWENTYTWO FUNCTIONS In this chapterwe are going to learn about the next topics :- • Define functions • Call functions • Declare parameters • Send parameters • Main Function • Variables Scope • Return Value • Recursion 22.1 Define Functions To define new function Syntax: func <function_name> [parameters] Block of statements Note: No keyword is required to end the function definition. Example: func hello see "Hello from function" + nl 22.2 Call Functions To call function without parameters, we type the function name then () Tip: We can call the function before the function definition and the function code. Example: 115
- 139. Ring Documentation, Release1.4.1 hello() func hello see "Hello from function" + nl Example: first() second() func first see "message from the first function" + nl func second see "message from the second function" + nl 22.3 Declare parameters To declare the function parameters, after the function name type the list of parameters as a group of identifiers separated by comma. Example: func sum x,y see x+y+nl 22.4 Send Parameters To send parameters to function, type the parameters inside () after the function name Syntax: funcname(parameters) Example: /* output ** 8 ** 3000 */ sum(3,5) sum(1000,2000) func sum x,y see x+y+nl 22.5 Main Function Using the Ring programming language, the Main Function is optional, when it’s defined, it will be executed after the end of other statements. if no other statements comes alone, the main function will be the first entry point Example: 22.3. Declare parameters 116
- 140. Ring Documentation, Release1.4.1 # this program will print the hello world message first then execute the main function See "Hello World!" + nl func main see "Message from the main function" + nl 22.6 Variables Scope The Ring programming language uses lexical scoping to determine the scope of a variable. Variables defined inside functions (including function parameters) are local variables. Variables defined outside func- tions (before any function) are global variables. Inside any function we can access the variables defined inside this function beside the global variables. Example: # the program will print numbers from 10 to 1 x = 10 # x is a global variable. func main for t = 1 to 10 # t is a local variable mycounter() # call function next func mycounter see x + nl # print the global variable value x-- # decrement Note: Using the main function before the for loop declare the t variable as a local variable, It’s recommended to use the main functions instead of typing the instructions directly to set the scope of the new variables to local. 22.7 Return Value The function can return a value using the Return command. Syntax: Return [Expression] Tip: the Expression after the return command is optional and we can use the return command to end the function execution without returning any value. Note: if the function doesn’t return explicit value, it will return NULL (empty string = “” ). Example: 22.6. Variables Scope 117
- 141. Ring Documentation, Release1.4.1 if novalue() = NULL See "the function doesn't return a value" + nl ok func novalue 22.8 Recursion The Ring programming language support Recursion and the function can call itself using different parameters. Example: see fact(5) # output = 120 func fact x if x = 1 return 1 else return x * fact(x-1) ok 22.8. Recursion 118
- 142. CHAPTER TWENTYTHREE PROGRAM STRUCTURE In thischapter we will learn about using many source code files in the same project. 23.1 Source Code File Sections Each source code file may contains the next sections (in the same order). Source Code File Sections Load Files Statements and Global Variables Functions Packages and Classes The application maybe one or more of files. 23.2 Using Many Source Code Files To include another source file in the project, just use the load command. Syntax: Load "filename.ring" Note: The Load command is executed directly by the compiler in the parsing stage Tip: if you don’t know the file name until the runtime, or you need to use functions to get the file path, just use eval(). Example: # File : Start.ring Load "sub.ring" sayhello("Mahmoud") # File : sub.ring func sayhello cName see "Hello " + cName + nl 119
- 143. CHAPTER TWENTYFOUR LISTS In this chapterwe are going to learn how to deal with lists. 24.1 Create Lists We can create new lists by defining the list items inside square bracts. Example: aList = [1,2,3,4,5] Also we can create new lists using the : operator Example: aList = 1:5 aList2 = "a":"z" Example: aList = 5:1 aList2 = "z":"a" Also we can create lists using the list() function Syntax: list = list(size) Example aList = list(10) # aList contains 10 items Note: the list index start from 1 24.2 Add Items To add new items to the list, we can use the Add() function. Syntax: Add(List,Item) 120
- 144. Ring Documentation, Release1.4.1 Example: aList = ["one","two"] add(aList,"three") see aList Also we can do that using the + operator. Syntax: List + item Example: aList = 1:10 # create list contains numbers from 1 to 10 aList + 11 # add number 11 to the list see aList # print the list 24.3 Get List Size We can get the list size using the len() function Syntax: Len(List) Example: aList = 1:20 see len(aList) # print 20 24.4 Delete Item From List To delete an item from the list, we can use the del() function Syntax: del(list,index) Example: aList = ["one","two","other","three"] Del(aList,3) # delete item number three see aList # print one two three 24.5 Get List Item To get an item from the list, we uses the next syntax List[Index] Example: aList = ["Cairo","Riyadh"] see "Egypt : " + aList[1] + nl + "KSA : " + aList[2] + nl 24.3. Get List Size 121
- 145. Ring Documentation, Release1.4.1 24.6 Set List Item To set the value of an item inside the list, we can use the next syntax List[Index] = Expression Example: aList = list(3) # create list contains three items aList[1] = "one" aList[2] = "two" aList[3] = "three" see aList 24.7 Search To find an item inside the list we can use the find() function Syntax: Find(List,ItemValue) ---> Item Index Find(List,ItemValue,nColumn) ---> Search in nColumn, returns the Item Index Find(List,ItemValue,nColumn,cAttribute) ---> Item Index Example: aList = ["one","two","three","four","five"] see find(aList,"three") # print 3 Example: mylist = [["one",1], ["two",2], ["three",3]] see find(mylist,"two",1) + nl # print 2 see find(mylist,2,2) + nl # print 2 Also we can use the binarysearch() function to search in sorted list. Syntax: BinarySearch(List,ItemValue) ---> Item Index BinarySearch(List,ItemValue,nColumn) ---> Search in nColumn, returns the Item Index Example: aList = ["one","two","three","four","five"] aList = sort(aList) see binarysearch(aList,"three") Output: five four one three two 4 24.6. Set List Item 122
- 146. Ring Documentation, Release1.4.1 24.8 Sort We can sort the list using the sort() function. Syntax: Sort(List) ---> Sorted List Sort(List,nColumn) ---> Sorted List based on nColumn Sort(List,nColumn,cAttribute) ---> Sorted List based on Object Attribute Example: aList = [10,12,3,5,31,15] aList = sort(aList) see aList # print 3 5 10 12 15 31 We can sort list of strings Example: mylist = ["mahmoud","samir","ahmed","ibrahim","mohammed"] see mylist # print list before sorting mylist = sort(mylist) # sort list see "list after sort"+nl see mylist # print ahmed ibrahim mahmoud mohammed samir We can sort a list based on a specific column. Example: aList = [ ["mahmoud",15000] , ["ahmed", 14000 ] , ["samir", 16000 ] , ["mohammed", 12000 ] , ["ibrahim",11000 ] ] aList2 = sort(aList,1) see aList2 Output: ahmed 14000 ibrahim 11000 mahmoud 15000 mohammed 12000 samir 16000 24.9 Reverse We can reverse a list using the reverse() function. Syntax: 24.8. Sort 123
- 147. Ring Documentation, Release1.4.1 Reverse(List) ---> Reversed List Example: aList = [10,20,30,40,50] aList = reverse(aList) see aList # print 50 40 30 20 10 24.10 Insert Items To insert an item in the list we can use the insert() function. Syntax: Insert(List,Index,Item) The inserted item will be AFTER the Index Example: aList = ["A","B","D","E"] insert(aList,2,"C") # Inserts AFTER Index 2, "C" into Position 3 see aList # print A B C D E 24.11 Nested Lists The list may contain other lists Example: aList = [ 1 , [10,20,30] , 5 , [100,1000,5000] ] aList2 = [ "one","two", [3,4], [20,30], ["three", "four", "five",[100,200,300] ] ] see aList[2] # print 10 20 30 see aList[4][3] + nl # print 5000 see aList2[5][2] + nl # print four see aList2[5][4][3] # print 300 24.12 Copy Lists We can copy lists (including nested lists) using the Assignment operator. Example: 24.10. Insert Items 124
- 148. Ring Documentation, Release1.4.1 aList = [ "one","two", [3,4], [20,30], ["three", "four", "five",[100,200,300] ] ] aList2 = aList # Copy aList to aList2 aList2[5] = "other" # modify item number five see aList2[5] + nl # print other see aList[5] # print three four five 100 200 300 24.13 First-class lists Lists are first-class citizens where we can store lists in variables, pass lists to functions, and return lists from functions. Example: aList = duplicate( [1,2,3,4,5] ) see aList[10] + nl # print 5 see mylist() # print 10 20 30 40 50 func duplicate list nMax = len(list) for x = 1 to nMax list + list[x] next return list func mylist return [10,20,30,40,50] 24.14 Using Lists during definition We can use the list items while we are defining the list for the first time. Example: aList = [ [1,2,3,4,5] , aList[1] , aList[1] ] see aList # print 1 2 3 4 5 1 2 3 4 5 1 2 3 4 5 24.15 Passing Lists to Functions Lists are passed to functions by reference, This means that the called function will work on the same list and can modify it. Example: func main aList = [1,2,3,4,5] # create list, local in function main 24.13. First-class lists 125
- 149. Ring Documentation, Release1.4.1 myfunc(aList) # call function, pass list by reference see aList # print 1 2 3 4 5 6 7 8 9 10 func myfunc list list + [6,7,8,9,10] 24.16 Access List Items by String Index Instead of using numbers to determine the item index when we get item value or set item value, We can access items using string index if the item is a list contains two items and the first item is a string. Example: aList = [ ["one",1] , ["two",2] , ["three",3] ] see aList["one"] + nl + aList["two"] + nl + aList["three"] # print 1 2 3 This type of lists can be defined in a better syntax using the : and = operators. Example: aList = [ :one = 1 , :two = 2 , :three = 3 ] see aList["one"] + nl + aList["two"] + nl + aList["three"] + nl # print 1 2 3 see aList[1] # print one 1 Tip: using : before identifier (one word) means literal Note: using = inside list definition create a list of two items where the first item is the left side and the second item is the right side. We can add new items to the list using the string index Example: aList = [] aList["Egypt"] = "Cairo" aList["KSA"] = "Riyadh" see aList["Egypt"] + nl + # print Cairo aList["KSA"] + nl # print Riyadh 24.17 Passing Parameters Using List This type of lists is very good for passing parameters to functions Where the order of parameters will not be important (we can change the order). Also some parameters maybe optional. Example: 24.16. Access List Items by String Index 126
- 150. Ring Documentation, Release1.4.1 myconnect ( [ :server = "myserver.com" , :port = 80 , :username = "mahmoud" , :password = "password" ] ) func myconnect mypara # print connection details see "User Name : " + mypara[:username] + nl + "Password : " + mypara[:password] + nl + "Server : " + mypara[:server] + nl + "Port : " + mypara[:port] 24.18 Swap Items We can swap the list items using the Swap() function. Example: aList = [:one,:two,:four,:three] see aList see copy("*",50) + nl swap(aList,3,4) see aList Output one two four three ************************************************** one two three four 24.18. Swap Items 127
- 151. CHAPTER TWENTYFIVE STRINGS In this chapterwe are going to learn about strings creation and manipulation. 25.1 String Literals Syntax: cStr = "This is a string" cStr2 = 'Another string' cStr3 = :JustAnotherString cStr4 = `Yet "another" 'string' ! ` 25.2 Get String Length We can get the string length (letters count inside a string) using the len() function Syntax: len(string) ---> string length Example: cStr = "How are you?" see cStr + nl see "String size : " + len(cStr) + nl 25.3 Convert Letters Case Syntax: lower(string) ---> convert string letters to lower case upper(string) ---> convert string letters to UPPER case Example: cStr = "Welcome To The Ring Programming Language" see cStr + nl + upper(cStr) + nl + lower(cStr) 128
- 152. Ring Documentation, Release1.4.1 25.4 Access String Letters We can access a letter inside a string by the letter index Syntax: string[index] ---> get string letter string[index] = letter # set string letter Example: # print user name letter by letter (each letter in new line) See "Hello, Enter your name : " give cName for x = 1 to len(cName) see nl + cName[x] next We can use for in to get string letters. Example: # print user name letter by letter (each letter in new line) See "Hello, Enter your name : " give cName for x in cName see nl + x next We can modify the string letters Example: # convert the first letter to UPPER case See "Enter your name : " give cName cName[1] = upper(cName[1]) see "Hello " + cName 25.5 Left() Function We can get a specified number of characters from a string using the Left() function. The starting position is 1. Syntax: Left(string,count) Example: see left("Hello World!",5) # print Hello 25.6 Right() Function We can get a specified number of characters from a string using the Right() function. 25.4. Access String Letters 129
- 153. Ring Documentation, Release1.4.1 The starting position is the last character on the right. Syntax: Right(string,count) Example: see Right("Hello World!",6) # print World! 25.7 Trim() Function We can remove all leading and trailing spaces from a string using the Trim() function. Syntax: trim(string) Example: cMsg = " Welcome " see trim(cMsg) # print Welcome 25.8 Copy() Function We can duplicate a string more than one time using the copy() function. Syntax: copy(string,nCount) ---> string replicated nCount times Example see copy("***hello***",3) # print ***hello******hello******hello*** 25.9 Lines() Function We can count the number of lines inside a string using the Lines() function. Syntax: lines(string) ---> Number of lines inside the string Example: cStr = "Hello How are you? are you fine?" see lines(cStr) # print 3 25.7. Trim() Function 130
- 154. Ring Documentation, Release1.4.1 25.10 Substr() Function We can work on sub strings inside a string using the substr() function. Using Substr() we can • Find substring • Get substring from position to end • Get Number of characters from position • Transform Substring To Another Substring 25.11 Find substring Syntax: substr(string,substring) ---> the starting position of substring in string Example: cStr = "Welcome to the Ring programming language" see substr(cStr,"Ring") # print 16 25.12 Get substring from position to end Syntax: substr(string,position) ---> Get substring starting from position to end Example: cStr = "Welcome to the Ring programming language" nPos = substr(cStr,"Ring") # nPos = 16 see substr(cStr,nPos) # print Ring programming language 25.13 Get Number of Characters From Position Syntax: substr(string,position,count) ---> Get characters starting from position Example: cStr = "Welcome to the Ring programming language" nPos = substr(cStr,"Ring") # nPos = 16 see substr(cStr,nPos,4) # print Ring 25.14 Transform Substring To Another Substring Syntax: 25.10. Substr() Function 131
- 155. Ring Documentation, Release1.4.1 substr(string,substring,newsubstring) ---> Transformed string (Match case) substr(string,substring,newsubstring,1) ---> Transformed string (Ignore case) Example: cStr = "Welcome to the New programming language" see substr(cStr,"New","Ring") + nl # print Welcome to the Ring programming language see substr(cStr,"new","Ring",1)+ nl # print Welcome to the Ring programming language 25.15 strcmp() Function We can compare between two strings using the strcmp() function. Syntax: strcmp(cString1,cString2) ---> value = 0 if cString1 = cString2 value < 0 if cString1 < cString2 value > 0 if cString1 > cString2 Example: see strcmp("hello","hello") + nl + strcmp("abc","bcd") + nl + strcmp("bcd","abc") + nl Output: 0 -1 1 25.16 str2list() and list2str() Functions We can convert string lines to list items using the str2list() function. Also we can convert the list to a string using list2str() function. Syntax: str2list(string) ---> list contains the string lines list2str(list) ---> string contains the list items Example: /* output: ** Items : 4 ** Item : Hello ** Item : How are you ? ** Item : are you fine ? ** Item : ok ** list2Str result = Hello ** How are you ? ** are you fine ? ** ok ** Done */ 25.15. strcmp() Function 132
- 156. Ring Documentation, Release1.4.1 mystr = "Hello How are you ? are you fine ? ok" mylist = str2list(mystr) see "Items : " + len(mylist) + nl for x in mylist see "Item : " + x + nl next newstr = list2str(mylist) see "list2Str result = " + newstr if mystr = newstr see nl + "Done" else see nl + "Error!" ok 25.16. str2list() and list2str() Functions 133
- 157. CHAPTER TWENTYSIX DATE AND TIME Inthis chapter we are going to learn about the date and time functions. 26.1 Clock() Function Syntax: Clock() ---> The number of clock ticks from program start Example: See "Calculate performance" + nl t1 = clock() for x = 1 to 1000000 next see clock() - t1 26.2 ClocksPerSecond() Function Return how many clocks in one second Syntax: clockspersecond() ---> Number of clocks in one second Example: # Wait 1 second t = clock() while clock() - t <= clockspersecond() end 26.3 Time() Function We can get the system time using the Time() function. Example: See "Time : " + time() 134
- 158. Ring Documentation, Release1.4.1 26.4 Date() Function We can get the date using the Date() function. Syntax: Date() ---> String represent the date "dd/mm/yyyy" Example: See "Date : " + date() # Date : 24/05/2015 26.5 TimeList() Function We can print the date and the time information using the TimeList() function. Syntax: TimeList() ---> List contains the time and date information. The next table presents the list items index value 1 abbreviated weekday name 2 full weekday name 3 abbreviated month name 4 full month name 5 Date & Time 6 Day of the month 7 Hour (24) 8 Hour (12) 9 Day of the year 10 Month of the year 11 Minutes after hour 12 AM or PM 13 Seconds after the hour 14 Week of the year (sun-sat) 15 day of the week 16 date 17 time 18 year of the century 19 year 20 time zone 21 percent sign Example: /* Output: ** Sun abbreviated weekday name ** Sunday full weekday name ** May abbreviated month name ** May full month name ** 05/24/15 09:58:38 Date & Time ** 24 Day of the month ** 09 Hour (24) 26.4. Date() Function 135
- 159. Ring Documentation, Release1.4.1 ** 09 Hour (12) ** 144 Day of the year ** 05 Month of the year ** 58 Minutes after hour ** AM AM or PM ** 38 Seconds after the hour ** 21 Week of the year (sun-sat) ** 0 day of the week ** 05/24/15 date ** 09:58:38 time ** 15 year of the century ** 2015 year ** Arab Standard Time time zone ** % percent sign */ See TimeList() Example: See "Day Name : " + TimeList()[2] # Sunday Example: See "Month Name : " + TimeList()[4] # May 26.6 AddDays() Function Syntax: AddDays(cDate,nDays) ---> Date from cDate and after nDays Example: cDate = date() see cDate + nl # 24/05/2015 cDate = adddays(cDate,10) see cDate + nl # 03/06/2015 26.7 DiffDays() Function Syntax: DiffDays(cDate1,cDate2) ---> number of days (Date1 - Date2) Example: cDate1 = date() see cDate1 + nl # 24/05/2015 cDate2 = adddays(cDate1,10) see cDate2 + nl # 03/06/2015 see "DiffDays = " + diffdays(cDate1,cDate2) + nl # -10 see "DiffDays = " + diffdays(cDate2,cDate1) + nl # 10 26.6. AddDays() Function 136
- 160. Ring Documentation, Release1.4.1 26.8 EpochTime() Function Syntax: EpochTime( cDate, cTime ) ---> Epoch Seconds Example: ###------------------------------------------------------------- # EpochTime() # Example --- EpochSec = EpochTime( Date(), Time() ) # Call Format: EpochSec = EpochTime( "15/07/2016", "10:15:30" ) # EpochSec = 1468577730 #--------------------------------------------------------------- Func EpochTime(Date, Time) arrayDate = split(Date, "/") arrayTime = split(Time, ":") Year = arrayDate[3] ; Month = arrayDate[2] ; Day = arrayDate[1] Hour = arrayTime[1] ; Minute = arrayTime[2] ; Second = arrayTime[3] cDate1 = Day +"/"+ Month +"/"+ Year cDate2 = "01/01/" + Year DayOfYear = DiffDays( cDate1, cDate2) ### Formula tm_sec = Second * 1 tm_min = Minute * 60 tm_hour = Hour * 3600 tm_yday = DayOfYear * 86400 tm_year = Year - 1900 tm_year1 = ( tm_year - 70) * 31536000 tm_year2 = ( floor(( tm_year - 69) / 4 )) * 86400 tm_year3 = ( floor(( tm_year - 1) / 100 )) * 86400 tm_year4 = ( floor(( tm_year + 299) / 400 )) * 86400 ### Result EpochSec = tm_sec + tm_min + tm_hour + tm_yday + tm_year1 + tm_year2 - tm_year3 + tm_year4 return EpochSec 26.8. EpochTime() Function 137
- 161. CHAPTER TWENTYSEVEN CHECK DATA TYPEAND CONVERSION In this chapter we are going to learn about the functions that can be used for • Checking Data Type • Checking Character • Conversion 27.1 Check Data Type The next functions can be used to check the data type • isstring() • isnumber() • islist() • type() • isnull() 27.2 IsString() Function Using the IsString() function we can know if the value is a string or not Syntax: IsString(value) ---> 1 if the value is a string or 0 if not Example: see isstring(5) + nl + # print 0 isstring("hello") + nl # print 1 27.3 IsNumber() Function Using the IsNumber() function we can know if the value is a number or not Syntax: 138
- 162. Ring Documentation, Release1.4.1 IsNumber(value) ---> 1 if the value is a number or 0 if not Example: see isnumber(5) + nl + # print 1 isnumber("hello") + nl # print 0 27.4 IsList() Function Using the IsList() function we can know if the value is a list or not Syntax: IsList(value) ---> 1 if the value is a list or 0 if not Example: see islist(5) + nl + # print 0 islist("hello") + nl + # print 0 islist([1,3,5]) # print 1 27.5 Type() Function We can know the type of a value using the Type() Function. Syntax: Type(value) ---> The Type as String Example: see Type(5) + nl + # print NUMBER Type("hello") + nl + # print STRING Type([1,3,5]) # print LIST 27.6 IsNULL() Function We can check the value to know if it’s null or not using the IsNULL() function Syntax: IsNULL(value) ---> 1 if the value is NULL or 0 if not Example: see isnull(5) + nl + # print 0 isnull("hello") + nl + # print 0 isnull([1,3,5]) + nl + # print 0 isnull("") + nl + # print 1 isnull("NULL") # print 1 27.4. IsList() Function 139
- 163. Ring Documentation, Release1.4.1 27.7 Check Character The next functions can be used to check character • isalnum() • isalpha() • iscntrl() • isdigit() • isgraph() • islower() • isprint() • ispunct() • isspace() • isupper() • isxdigit() 27.8 IsAlNum() Function We can test a character or a string using the IsAlNum() Function Syntax: IsAlNum(value) ---> 1 if the value is digit/letter or 0 if not Example: see isalnum("Hello") + nl + # print 1 isalnum("123456") + nl + # print 1 isalnum("ABCabc123") + nl + # print 1 isalnum("How are you") # print 0 because of spaces 27.9 IsAlpha() Function We can test a character or a string using the IsAlpha() Function Syntax: IsAlpha(value) ---> 1 if the value is a letter or 0 if not Example: see isalpha("Hello") + nl + # print 1 isalpha("123456") + nl + # print 0 isalpha("ABCabc123") + nl + # print 0 isalpha("How are you") # print 0 27.7. Check Character 140
- 164. Ring Documentation, Release1.4.1 27.10 IsCntrl() Function We can test a character or a string using the IsCntrl() Function Syntax: IsCntrl(value) ---> 1 if the value is a control character (no printing position) or 0 if not Example: See iscntrl("hello") + nl + # print 0 iscntrl(nl) # print 1 27.11 IsDigit() Function We can test a character or a string using the IsDigit() Function Syntax: IsDigit(value) ---> 1 if the value is a digit or 0 if not Example: see isdigit("0123456789") + nl + # print 1 isdigit("0123a") # print 0 27.12 IsGraph() Function We can test a character or a string using the IsGraph() Function Syntax: IsGraph(value) ---> 1 if the value can be printed (Except space) or 0 if not Example: see isgraph("abcdef") + nl + # print 1 isgraph("abc def") # print 0 27.13 IsLower() Function We can test a character or a string using the IsLower() Function Syntax: IsLower(value) ---> 1 if the value is lowercase letter or 0 if not Example: see islower("abcDEF") + nl + # print 0 islower("ghi") # print 1 27.10. IsCntrl() Function 141
- 165. Ring Documentation, Release1.4.1 27.14 IsPrint() Function We can test a character or a string using the IsPrint() Function Syntax: IsPrint(value) ---> 1 if the value occupies a printing position or 0 if not Example: see isprint("Hello") + nl + # print 1 isprint("Nice to see you") + nl + # print 1 isprint(nl) # print 0 27.15 IsPunct() Function We can test a character or a string using the IsPunct() Function Syntax: IsPunct(value) ---> 1 if the value is a punctuation character or 0 if not Example: see ispunct("hello") + nl + # print 0 ispunct(",") # print 1 27.16 IsSpace() Function We can test a character or a string using the IsSpace() Function Syntax: IsSpace(value) ---> 1 if the value is a white-space or 0 if not Example: see isspace(" ") + nl + # print 1 isspace("test") # print 0 27.17 IsUpper() Function We can test a character or a string using the IsUpper() Function Syntax: IsUpper(value) ---> 1 if the value is an uppercase alphabetic letter or 0 if not Example: see isupper("welcome") + nl + # print 0 isupper("WELCOME") # print 1 27.14. IsPrint() Function 142
- 166. Ring Documentation, Release1.4.1 27.18 IsXdigit() Function We can test a character or a string using the IsXdigit() Function Syntax: IsXdigit(value) ---> 1 if the value is a hexdecimal digit character or 0 if not Example: see isxdigit("0123456789abcdef") + nl + # print 1 isxdigit("123z") # print 0 27.19 Conversion The next functions can be used for conversion • number() • string() • ascii() • char() • hex() • dec() • str2hex() • hex2str() 27.20 Number() Function We can convert strings to numbers using the Number() function or the + operator. Syntax: Number(string) ---> Number 0 + string ---> Number Example: see number("5") + 5 + nl # print 10 see 0 + "10" + 2 # print 12 27.21 String() Function We can convert numbers to strings using the String() function or the + operator. Syntax: String(number) ---> String "" + number ---> String 27.18. IsXdigit() Function 143
- 167. Ring Documentation, Release1.4.1 Example: see string(5) + 5 + nl # print 55 see "" + 10 + 2 # print 102 27.22 Ascii() Function We can get the ASCII code for a letter using the Ascii() function Syntax: Ascii(character) ---> ASCII Code Example: See ascii("m") + nl + # print 109 ascii("M") # print 77 27.23 Char() Function We can convert the ASCII code to character using the Char() function. Syntax: Char(ASCII Code) ---> character Example: See char(109) + nl + # print m char(77) # print M 27.24 Hex() Function We can convert decimal to hexadecimal using the Hex() function. Syntax: Hex(decimal) ---> hexadecimal Example: See hex(10) + nl + # print a hex(200) # print c8 27.25 Dec() Function We can convert hexadecimal to decimal using the Dec() function Syntax: Dec(hexadecimal) ---> decimal 27.22. Ascii() Function 144
- 168. Ring Documentation, Release1.4.1 Example: See dec("a") + nl + # print 10 dec("c8") # print 200 27.26 Str2hex() Function We can convert string characters to hexadecimal characters using the Str2hex() function. Syntax: Str2hex(string) ---> hexadecimal string Example: See str2hex("hello") # print 68656c6c6f 27.27 Hex2str() Function We can convert hexadecimal characters to string using the Hex2str() function Syntax: Hex2Str(Hexadecimal string) ---> string Example: See hex2str("68656c6c6f") # print hello 27.26. Str2hex() Function 145
- 169. CHAPTER TWENTYEIGHT MATHEMATICAL FUNCTIONS In thischapter we are going to learn about the mathematical functions 28.1 List of functions The Ring programming language comes with the next mathematical functions Function Description sin(x) Returns the sine of an angle of x radians cos(x) Returns the cosine of an angle of x radians tan(x) Returns the tangent of an angle of x radians asin(x) Returns the principal value of the arc sine of x, expressed in radians acos(x) Returns the principal value of the arc cosine of x, expressed in radians atan(x) Returns the principal value of the arc tangent of x, expressed in radians atan2(y,x) Returns the principal arc tangent of y/x, in the interval [-pi,+pi] radians sinh(x) Returns the hyperbolic sine of x radians cosh(x) Returns the hyperbolic cosine of x radians tanh(x) Returns the hyperbolic tangent of x radians exp(x) Returns the value of e raised to the xth power log(x) Returns the natural logarithm of x log10(x) Returns the common logarithm (base-10 logarithm) of x ceil(x) Returns the smallest integer value greater than or equal to x floor(x) Returns the largest integer value less than or equal to x fabs(x) Returns the absolute value of x. pow(x,y) Returns x raised to the power of y sqrt(x) Returns the square root of x random(x) Returns a random number in the range [0,x] unsigned(n,n,c) Perform operation using unsigned numbers decimals(n) Determine the decimals digits after the point in float/double numbers 28.2 Example See "Mathematical Functions" + nl See "Sin(0) = " + sin(0) + nl See "Sin(90) radians = " + sin(90) + nl See "Sin(90) degree = " + sin(90*3.14/180) + nl See "Cos(0) = " + cos(0) + nl See "Cos(90) radians = " + cos(90) + nl 146
- 170. Ring Documentation, Release1.4.1 See "Cos(90) degree = " + cos(90*3.14/180) + nl See "Tan(0) = " + tan(0) + nl See "Tan(90) radians = " + tan(90) + nl See "Tan(90) degree = " + tan(90*3.14/180) + nl See "asin(0) = " + asin(0) + nl See "acos(0) = " + acos(0) + nl See "atan(0) = " + atan(0) + nl See "atan2(1,1) = " + atan2(1,1) + nl See "sinh(0) = " + sinh(0) + nl See "sinh(1) = " + sinh(1) + nl See "cosh(0) = " + cosh(0) + nl See "cosh(1) = " + cosh(1) + nl See "tanh(0) = " + tanh(0) + nl See "tanh(1) = " + tanh(1) + nl See "exp(0) = " + exp(0) + nl See "exp(1) = " + exp(1) + nl See "log(1) = " + log(1) + nl See "log(2) = " + log(2) + nl See "log10(1) = " + log10(1) + nl See "log10(2) = " + log10(2) + nl See "log10(10) = " + log10(10) + nl See "Ceil(1.12) = " + Ceil(1.12) + nl See "Ceil(1.72) = " + Ceil(1.72) + nl See "Floor(1.12) = " + floor(1.12) + nl See "Floor(1.72) = " + floor(1.72) + nl See "fabs(1.12) = " + fabs(1.12) + nl See "fabs(1.72) = " + fabs(1.72) + nl See "pow(2,3) = " + pow(2,3) + nl see "sqrt(16) = " + sqrt(16) + nl Program Output: Mathematical Functions Sin(0) = 0 Sin(90) radians = 0.89 Sin(90) degree = 1.00 Cos(0) = 1 Cos(90) radians = -0.45 Cos(90) degree = 0.00 Tan(0) = 0 Tan(90) radians = -2.00 Tan(90) degree = 1255.77 asin(0) = 0 acos(0) = 1.57 atan(0) = 0 atan2(1,1) = 0.79 sinh(0) = 0 sinh(1) = 1.18 cosh(0) = 1 28.2. Example 147
- 171. Ring Documentation, Release1.4.1 cosh(1) = 1.54 tanh(0) = 0 tanh(1) = 0.76 exp(0) = 1 exp(1) = 2.72 log(1) = 0 log(2) = 0.69 log10(1) = 0 log10(2) = 0.30 log10(10) = 1 Ceil(1.12) = 2 Ceil(1.72) = 2 Floor(1.12) = 1 Floor(1.72) = 1 fabs(1.12) = 1.12 fabs(1.72) = 1.72 pow(2,3) = 8 sqrt(16) = 4 28.3 Random() Function The Random() function generate a random number and we can set the maximum value (optional). Syntax: Random(x) ---> Random number in the range [0,x] Example: for x = 1 to 20 see "Random number : " + random() + nl + "Random number Max (100) : " + random(100) + nl next Program Output: Random number : 31881 Random number Max (100) : 80 Random number : 5573 Random number Max (100) : 63 Random number : 2231 Random number Max (100) : 43 Random number : 12946 Random number Max (100) : 39 Random number : 22934 Random number Max (100) : 48 Random number : 4690 Random number Max (100) : 52 Random number : 13196 Random number Max (100) : 65 Random number : 30390 Random number Max (100) : 87 Random number : 4327 Random number Max (100) : 77 Random number : 12456 Random number Max (100) : 17 Random number : 28438 28.3. Random() Function 148
- 172. Ring Documentation, Release1.4.1 Random number Max (100) : 13 Random number : 30503 Random number Max (100) : 6 Random number : 31769 Random number Max (100) : 94 Random number : 8274 Random number Max (100) : 65 Random number : 14390 Random number Max (100) : 90 Random number : 28866 Random number Max (100) : 12 Random number : 24558 Random number Max (100) : 70 Random number : 29981 Random number Max (100) : 77 Random number : 12847 Random number Max (100) : 63 Random number : 6632 Random number Max (100) : 60 28.4 Unsigned() Function We can use unsigned numbers using the Unsigned() function. Syntax: Unsigned(nNum1,nNum2,cOperator) --> result of cOperator operation on nNum1,nNum2 Example: see oat_hash("hello") + nl # Jenkins hash function - https://en.wikipedia.org/wiki/Jenkins_hash_function func oat_hash cKey h = 0 for x in cKey h = unsigned(h,ascii(x),"+") h = unsigned(h,unsigned(h,10,"<<"),"+") r = unsigned(h,6,">>") h = unsigned(h, r,"^") next h = unsigned(h,unsigned(h,3,"<<"),"+") h = unsigned(h,unsigned(h,11,">>"),"^") h = unsigned(h,unsigned(h,15,"<<"),"+") return h Output: 3372029979.00 28.5 Decimals() Functions We can determine the decimals numbers count after the point in float/double numbers using the decimals() function. Syntax: 28.4. Unsigned() Function 149
- 173. Ring Documentation, Release1.4.1 Decimals(nDecimalsCount) Example: x = 1.1234567890123 for d = 0 to 14 decimals(d) see x + nl next Output: 1 1.1 1.12 1.123 1.1235 1.12346 1.123457 1.1234568 1.12345679 1.123456789 1.1234567890 1.12345678901 1.123456789012 1.1234567890123 1.12345678901230 28.5. Decimals() Functions 150
- 174. CHAPTER TWENTYNINE FILES In this chapterwe are going to learn about files functions. • Read() • Write() • Dir() • Rename() • Remove() • fopen() • fclose() • fflush() • freopen() • tempfile() • tempname() • fseek() • ftell() • rewind() • fgetpos() • fsetpos() • clearerr() • feof() • ferror() • perror() • fgetc() • fgets() • fputc() • fputs() • ungetc() • fread() 151
- 175. Ring Documentation, Release1.4.1 • fwrite() • fexists() • Numbers and Bytes 29.1 Read() Function We can read the file content using the Read() function Syntax: Read(cFileName) ---> String contains the file content Example: see read("myfile.txt") The read function can read binary files too Example: see read("myapp.exe") 29.2 Write() Function We can write string to file using the Write() function The write function can write binary data to binary files. Syntax: Write(cFileName,cString) # write string cString to file cFileName Example: # copy file cFile = read("ring.exe") write("ring2.exe",cFile) 29.3 Dir() Function We can get the folder contents (files & sub folders) using the Dir() function. Syntax: Dir(cFolderPath) ---> List contains files & sub folders. This function returns a list and each list item is a list of two items • File/sub folder name • Type (0 = File , 1 = Folder/Directory) Example: 29.1. Read() Function 152
- 176. Ring Documentation, Release1.4.1 see "Testing DIR() " + nl mylist = dir("C:myfolder") for x in mylist if x[2] see "Directory : " + x[1] + nl else see "File : " + x[1] + nl ok next see "Files count : " + len(mylist) 29.4 Rename() Function We can rename files using the Rename() function Syntax: Rename(cOldFileName,cNewFileName) Example: rename("file.txt","help.txt") 29.5 Remove() Function We can delete a file using the Remove() function Syntax: Remove(cFileName) Example: remove("test.txt") 29.6 Fopen() Function We can open a file using the Fopen() function Syntax: Fopen(cFileName,cMode) ---> File Handle Mode Description “r” Reading (The file must exist) “w” Writing (create empty file / overwrite) “a” Appends (create file if it doesn’t exist) “r+” update (reading/writing) “w+” Create empty file (reading/writing) “a+” reading & appending 29.4. Rename() Function 153
- 177. Ring Documentation, Release1.4.1 29.7 Fclose() Function When we open a file using fopen() function, we can close it using the Fclose() function Syntax: Fclose(file handle) 29.8 Fflush() Function We can flushes the output buffer of a stream using the Fflush() function Syntax: Fflush(file handle) 29.9 Freopen() Function We can open another file using the same file handle and at the same file close the old file Syntax: Freopen(cFileName,cMode,file handle) ---> file handle Example: freopen("myprogoutput.txt","w+",stdout) see "welcome" + nl for x = 1 to 10 see x + nl next /* ** Read : https://en.wikipedia.org/wiki/Device_file#Device_files ** The next code is not portable, we can use iswindows() before ** using it and we can write special code for each operating system. */ freopen("CON","w",stdout) # For Microsoft Windows see "Done" + nl # print to stdout again Output: # Output to stdout Done # Output to file : myprogoutput.txt welcome 1 2 3 4 5 6 7 29.7. Fclose() Function 154
- 178. Ring Documentation, Release1.4.1 8 9 10 29.10 Tempfile() Function The function Tempfile() creates a temp. file (binary). The file will be deleted automatically when the stream is closed Syntax: TempFile() ---> file handle 29.11 Tempname() Function We can generate temp. file name using the Tempname() function The generated name will be different from the name of any existing file Syntax: Tempname() ---> generated file name as string 29.12 Fseek() Function We can set the file position of the stream using the Fseek() function Syntax: Fseek(file handle, nOffset, nWhence) ---> zero if successful The next table presents the nWhence values Value Description 0 Beginning of file 1 Current position 2 End of file 29.13 Ftell() Function We can know the current file position of a stream using the Ftell() function Syntax: Ftell(file handle) ---> file position as number 29.10. Tempfile() Function 155
- 179. Ring Documentation, Release1.4.1 29.14 Rewind() Function We can set the file position to the beginning of the file using the Rewind() function Syntax: Rewind(file handle) 29.15 Fgetpos() Function We can get handle to the current file position using the Fgetpos() function Syntax: Fgetpos(file handle) ---> position handle 29.16 Fsetpos() Function We can set the current file position using the Fgetpos() function Syntax: Fsetpos(file handle,position handle) 29.17 Clearerr() Function We can clear the EOF error and the error indicators of a stream using the clearerr() function Syntax: Clearerr(file handle) 29.18 Feof() Function We can test the end-of-file indicator using the Feof() function Syntax: Feof(file handle) ---> returns 1 if EOF and 0 if not 29.19 Ferror() Function We can test the error indicator of a given stream using the Ferror() function Syntax: Ferror(file handle) ---> returns 1 if error and 0 if not 29.14. Rewind() Function 156
- 180. Ring Documentation, Release1.4.1 29.20 Perror() Function We can print error message to the stderr using the Perror() function Syntax: Perror(cErrorMessage) 29.21 Fgetc() Function We can get the next character from the stream using the Fgetc() function Syntax: Fgetc(file handle) ---> returns character or EOF 29.22 Fgets() Function We can read new line from the stream using the Fgets() function Syntax: Fgets(file handle,nSize) ---> string The function stop when nSize characters are read, new line character is read or EOF. 29.23 Fputc() Function We can write a character to the stream using the Fputc() function Syntax: Fputc(file handle,cChar) 29.24 Fputs() Function We can write a string to the stream using the Fputs() function Syntax: Fputs(file handle,cString) 29.25 Ungetc() Function We can push a character to the stream using the Ungetc() function The character will be available for the next read Syntax: 29.20. Perror() Function 157
- 181. Ring Documentation, Release1.4.1 Ungetc(file handle,character) 29.26 Fread() Function We can read data from a stream using the Fread() function Syntax: Fread(file handle,nSize) 29.27 Fwrite() Function We can write data to a stream using the Fwrite() function Syntax: Fwrite(file handle,cString) 29.28 Fexists() Function We can check if a file exists using the Fexists() function Syntax: Fexists(cFileName) ---> returns 1 if the file exists Example: see fexists("b:mahmoudappsringring.exe") + nl + fexists("b:mahmoudappsringring2.exe") + nl Output: 1 0 29.29 Example The next program test some of the file functions See "testing file functions" + nl See "open file" + nl fp = fopen(exefolder() + "../tests/scripts/s65.ring","r") See "reopen" + nl fp = freopen(exefolder() + "../tests/scripts/s78.ring","r",fp) See "close file" + nl fclose(fp) see "temp file" + nl 29.26. Fread() Function 158
- 182. Ring Documentation, Release1.4.1 fp = tempfile() fclose(fp) see "temp name" + nl see tempname() + nl remove(exefolder() + "../tests/scripts/mytest2.txt") write(exefolder() + "../tests/scripts/tests1.txt","hello") rename(exefolder() + "../tests/scripts/test1.txt",exefolder() + "../tests/scripts/mytests2.txt") see "print file" + nl fp = fopen(exefolder() + "../samples/fromdoc/filefuncs.ring","r") r = fgetc(fp) while isstring(r) see r r = fgetc(fp) end fclose(fp) see nl+"print line from the file" + nl fp = fopen(exefolder() + "../samples/fromdoc/filefuncs.ring","r") r = fgets(fp,33) see r + nl fclose(fp) fp = fopen(exefolder() + "../tests/scripts/test78.txt","w+") fseek(fp,0,2) # goto end of file fputc(fp,"t") fputc(fp,"e") fputc(fp,"s") fputc(fp,"t") fputs(fp,"tests2") fclose(fp) see "print file" + nl see read(exefolder() + "../tests/scripts/test78.txt") fp = fopen(exefolder() + "../tests/scripts/test78.txt","r") see "testing ungetc() " + nl for x = 1 to 3 r = fgetc(fp) see r + nl ungetc(fp,r) next fclose(fp) see "testing fread() " + nl fp = fopen(exefilename(),"rb") r = fread(fp,100) see r + nl fclose(fp) see "testing fwrite() " + nl fp = fopen(exefolder() + "../tests/scripts/test1.txt","wb") fwrite(fp,r) fclose(fp) The next example print part of the content of a binary file 29.29. Example 159
- 183. Ring Documentation, Release1.4.1 see "Testing: fread()" +" FileName: "+ exefilename() +nl +nl fp = fopen(exefilename(),"rb") r = fread(fp,800) for n =1 to len(r) if isprint(substr(r, n, 1)) see substr(r, n, 1) else see "." ok ### 80 char per line if n % 80 = 0 see nl ok next fclose(fp) 29.30 Numbers and Bytes The next functions to convert between Numbers and Bytes. • Int2Bytes() • Float2Bytes() • Double2Bytes() • Bytes2Int() • Bytes2Float() • Bytes2Double() Example: see "Test Int2Bytes() and Bytes2Int() - Value : 77" + nl r = Int2Bytes(77) see "Int Size : " + len(r) + nl see r + nl see Bytes2Int(r) + nl see "Test Float2Bytes() and Bytes2Float() - Value 77.12" + nl r = Float2Bytes(77.12) see "Float Size : " + len(r) + nl see r + nl see Bytes2Float(r) + nl see "Test Double2Bytes() and Bytes2Double() - Value 9999977.12345" + nl r = Double2Bytes(9999977.12345) see "Double Size : " + len(r) + nl see r + nl decimals(5) see Bytes2Double(r) + nl 29.30. Numbers and Bytes 160
- 184. CHAPTER THIRTY SYSTEM FUNCTIONS In thischapter we are going to learn about the system functions • System() • SysGet() • IsMSDOS() • IsWindows() • IsWindows64() • IsUnix() • IsMacOSX() • IsLinux() • IsFreeBSD() • IsAndroid() • Windowsnl() • Get Command Line Arguments • Get Active Source File Name • CurrentDir() • ExeFileName() • ChDir() • ExeFolder() • Version() 30.1 System() Function We can execute system commands using the system() function Syntax: System(cCommand) Example: System("myapp.exe") # Run myapp.exe System("ls") # print list of files 161
- 185. Ring Documentation, Release1.4.1 30.2 SysGet() Function We can get environment variables using the Get() function Syntax: SysGet(cVariable) Example: see sysget("path") # print system path information 30.3 IsMSDOS() Function We can check if the operating system is MSDOS or not using the IsMSDOS() function Syntax: IsMSDOS() ---> Returns 1 if the operating system is MS-DOS, Returns 0 if it's not 30.4 IsWindows() Function We can check if the operating system is Windows or not using the IsWindows() function Syntax: IsWindows() ---> Returns 1 if the operating system is Windows, Returns 0 if it's not 30.5 IsWindows64() Function We can check if the operating system is Windows 64bit or not using the IsWindows64() function Syntax: IsWindows64() ---> Returns 1 if the operating system is Windows64, Returns 0 if it's not 30.6 IsUnix() Function We can check if the operating system is Unix or not using the IsUnix() function Syntax: IsUnix() ---> Returns 1 if the operating system is Unix, Returns 0 if it's not 30.7 IsMacOSX() Function We can check if the operating system is Mac OS X or not using the IsMacOSX() function Syntax: 30.2. SysGet() Function 162
- 186. Ring Documentation, Release1.4.1 IsMacOSX() ---> Returns 1 if the operating system is Mac OS X, Returns 0 if it's not 30.8 IsLinux() Function We can check if the operating system is Linux or not using the IsLinux() function Syntax: IsLinux() ---> Returns 1 if the operating system is Linux, Returns 0 if it's not 30.9 IsFreeBSD() Function We can check if the operating system is FreeBSD or not using the IsFreeBSD() function Syntax: IsFreeBSD() ---> Returns 1 if the operating system is FreeBSD, Returns 0 if it's not 30.10 IsAndroid() Function We can check if the operating system is Android or not using the IsAndroid() function Syntax: IsAndroid() ---> Returns 1 if the operating system is Android, Returns 0 if it's not 30.11 Example see "IsMSDOS() --> " + ismsdos() + nl see "IsWindows() --> " + iswindows() + nl see "IsWindows64() --> " + iswindows64() + nl see "IsUnix() --> " + isunix() + nl see "IsMacOSX() --> " + ismacosx() + nl see "IsLinux() --> " + islinux() + nl see "IsFreeBSD() --> " + isfreebsd() + nl see "IsAndroid() --> " + isandroid() + nl Output: IsMSDOS() --> 0 IsWindows() --> 1 IsWindows64() --> 0 IsUnix() --> 0 IsMacOSX() --> 0 IsLinux() --> 0 IsFreeBSD() --> 0 IsAndroid() --> 0 30.8. IsLinux() Function 163
- 187. Ring Documentation, Release1.4.1 30.12 Windowsnl() Function We can get the windows new line string using the Windowsnl() function. Syntax: WindowsNL() ---> Returns a string contains CR+LF = CHAR(13) + CHAR(10) Example: cStr = read("input.txt") if iswindows() cStr = substr(cStr,windowsnl(),nl) ok aList = str2list(cStr) # to do - list items processing using "for in" cStr = list2str(aList) if iswindows() cStr = substr(cStr,nl,windowsnl()) ok write("ouput.txt",cStr) 30.13 Get Command Line Arguments We can get the command line arguments passed to the ring script using the sysargv variable. The sysargv variable is a list contains the command line parameters. Example see copy("=",30) + nl see "Command Line Parameters" + nl see "Size : " + len(sysargv) + nl see sysargv see copy("=",30) + nl if len(sysargv) < 4 return ok nStart = sysargv[3] nEnd = sysargv[4] for x = nStart to nEnd see x + nl next Output b:mahmoudappsring>ring testssyspara.ring 1 10 ============================== Command Line Parameters Size : 4 ring testssyspara.ring 1 10 ============================== 30.12. Windowsnl() Function 164
- 188. Ring Documentation, Release1.4.1 1 2 3 4 5 6 7 8 9 10 30.14 Get Active Source File Name We can get the active source file name (*.ring) using the filename() function Syntax: filename() ---> String contains the active source file name. Example: see "Active Source File Name : " + filename() + nl Output: Active Source File Name : testsfilename.ring Example: if sysargv[2] = filename() see "I'm the main program file!" + nl # we can run tests here! else see "I'm a sub file in a program" + nl ok 30.15 PrevFileName() Function Using the PrevFileName() function we can get the previous active source file name. The previous file would be the file of the caller function, Or the file of the function that we called before calling PrevFileName(). Syntax: prevfilename() ---> String contains the previous source file name. Example: The next function in stdlib.ring uses the PrevFileName() to know if the file of the caller function is the main source file of the program or not. Func IsMainSourceFile if PrevFileName() = sysargv[2] return true ok return false 30.14. Get Active Source File Name 165
- 189. Ring Documentation, Release1.4.1 30.16 CurrentDir() Function Return the path of the current directory Syntax: CurrenDir() ---> String contains the path of the currect directory 30.17 ExeFileName() Function Return the Ring executable file name Syntax: exefilename() ---> String contains the Ring executable file name 30.18 ChDir() Function Change the current directory Syntax: ChDir(cNewPath) 30.19 ExeFolder() Function Return the Ring executable file path Syntax: exefolder() ---> String contains the Ring executable path 30.20 Version() Function Return the Ring version Syntax: version() ---> String contains the Ring version Output: 1.4.1 30.16. CurrentDir() Function 166
- 190. CHAPTER THIRTYONE EVAL() AND DEBUGGING Inthis chapter we are going to learn about • Error Handling using Try/Catch/Done • Eval() function • Raise() function • Assert() function 31.1 Try/Catch/Done Syntax: Try Statements... Catch Statements... Done The statements in the Try block will be executed, if any error happens then the statements in the catch block will be executed. Inside the catch block we can use the variable cCatchError to get the error message Example: Try see 5/0 Catch see "Catch!" + nl + cCatchError Done Output: Catch! Error (R1) : Cann't divide by zero ! 31.2 Eval() Function We can execute code during the runtime from string using the Eval() function Syntax: 167
- 191. Ring Documentation, Release1.4.1 Eval(cCode) Example: Eval("nOutput = 5+2*5 " ) See "5+2*5 = " + nOutput + nl Eval("for x = 1 to 10 see x + nl next") Eval("func test see 'message from test!' ") test() Output: 5+2*5 = 15 1 2 3 4 5 6 7 8 9 10 message from test! 31.3 Raise() Function We can raise an exception using the Raise() function Syntax: Raise(cErrorMessage) The function will display the error message then end the execution of the program. We can use Try/Catch/Done to avoid exceptions generated by raise() function. Example: nMode = 10 if nMode < 0 or nMode > 5 raise("Error : nMode not in the range 1:4") ok Output: Line 4 Error : nMode not in the range 1:4 In raise in file testsraise.ring Example: try testmode(6) catch see "avoid raise!" done testmode(-1) 31.3. Raise() Function 168
- 192. Ring Documentation, Release1.4.1 func testmode nMode if nMode < 0 or nMode > 5 raise("Error : nMode not in the range 1:4") ok Output: avoid raise! Line 12 Error : nMode not in the range 1:4 In raise In function testmode() in file testsraise2.ring called from line 7 in file testsraise2.ring 31.4 Assert() Function We can use the Assert() function to test conditions before executing the code If the test fail the program will be terminated with an error message contains the assert condition. Syntax: Assert( condition ) Example: x = 10 assert( x = 10) assert( x = 100 ) Output: Line 3 Assertion Failed! In assert in file testsassert.ring 31.4. Assert() Function 169
- 193. CHAPTER THIRTYTWO DEMO PROGRAMS In thischapter we will see simple demo programs • Language Shell • Main Menu 32.1 Language Shell We can create simple interactive programming environment using the next program while true see nl + "code:> " give cCode try eval(cCode) catch see cCatchError done end Output: code:> see "hello world" hello world code:> for x = 1 to 10 see x + nl next 1 2 3 4 5 6 7 8 9 10 code:> func test see "Hello from test" + nl code:> test() Hello from test code:> bye 170
- 194. Ring Documentation, Release1.4.1 32.2 Main Menu Example: # Demo Program while true see " Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit " give nMenu see nl # we can use Switch-ON-Other-OFF instead of IF-BUT-ELSE-OK Switch nMenu On 1 sayhello() On 2 Sum() On 3 Stars() On 4 see "Enter Number : " give x see "Output : " Try see Fact(number(x)) Catch see "Error in parameters!" + nl Done On "5" return Other see "bad option" + nl Off end func sayhello see "Enter your name ? " give fname see "Hello " + fname + nl func sum see "number 1 : " give num1 see "number 2 : " give num2 see "Sum : " see 0 + num1 + num2 func stars for x = 1 to 10 see space(8) for y = 1 to x see "*" next see nl next func fact x if x = 1 return 1 else return x * fact(x-1) ok 32.2. Main Menu 171
- 195. Ring Documentation, Release1.4.1 func space x y = "" for t=1 to x y += " " next return y Output: Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 1 Enter your name ? Mahmoud Fayed Hello Mahmoud Fayed Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 2 number 1 : 3 number 2 : 4 Sum : 7 Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 3 * ** *** **** ***** ****** ******* ******** ********* ********** Main Menu =========== [1] Say Hello [2] Sum two numbers 32.2. Main Menu 172
- 196. Ring Documentation, Release1.4.1 [3] Stars [4] Fact [5] Exit 4 Enter Number : 5 Output : 120 Main Menu =========== [1] Say Hello [2] Sum two numbers [3] Stars [4] Fact [5] Exit 5 32.2. Main Menu 173
- 197. CHAPTER THIRTYTHREE ODBC FUNCTIONS This chaptercontains the ODBC functions provided by the Ring programming language. • odbc_init() • odbc_drivers() • odbc_datasources() • odbc_close() • odbc_connect() • odbc_disconnect() • odbc_execute() • odbc_colcount() • odbc_fetch() • odbc_getdata() • odbc_tables() • odbc_columns() • odbc_autocommit() • odbc_commit() • odbc_rollback() Before using the next function load the odbclib.ring library load "odbclib.ring" # Use ODBC functions 33.1 odbc_init() Function We can create ODBC Handle using the odbc_init() function Syntax: odbc_init() ---> ODBC Handle 174
- 198. Ring Documentation, Release1.4.1 33.2 odbc_drivers() Function We can get a list of ODBC drivers using the odbc_drivers() function Syntax: odbc_drivers(ODBC Handle) ---> List of Drivers 33.3 odbc_datasources() Function We can get a list of ODBC data sources using the odbc_datasources() function Syntax: odbc_datasources(ODBC Handle) ---> List of Data sources 33.4 odbc_close() Function After the end of using ODBC functions we can free resources using ODBC_Close() function Syntax: odbc_close(ODBC Handle) 33.5 Print List of ODBC Drivers The next example print a list of ODBC drivers. See "ODBC test 1" + nl oODBC = odbc_init() See "Drivers " + nl see odbc_drivers(oODBC) odbc_close(oODBC) Output: ODBC test 1 Drivers Microsoft Access-Treiber (*.mdb) - SQLLevel=0 Driver do Microsoft Paradox (*.db ) - SQLLevel=0 Driver do Microsoft Excel(*.xls) - SQLLevel=0 Microsoft Text Driver (*.txt; *.csv) - SQLLevel=0 Driver da Microsoft para arquivos texto (*.txt; *.csv) - SQLLevel=0 Microsoft dBase-Treiber (*.dbf) - SQLLevel=0 SQL Server - CPTimeout=60 Microsoft Excel Driver (*.xls) - SQLLevel=0 Driver do Microsoft dBase (*.dbf) - SQLLevel=0 Microsoft Paradox-Treiber (*.db ) - SQLLevel=0 Microsoft ODBC for Oracle - CPTimeout=120 Microsoft Text-Treiber (*.txt; *.csv) - SQLLevel=0 Microsoft Excel-Treiber (*.xls) - SQLLevel=0 Microsoft Access Driver (*.mdb) - SQLLevel=0 Driver do Microsoft Access (*.mdb) - SQLLevel=0 33.2. odbc_drivers() Function 175
- 199. Ring Documentation, Release1.4.1 Microsoft Paradox Driver (*.db ) - SQLLevel=0 Microsoft dBase Driver (*.dbf) - SQLLevel=0 Microsoft Access Driver (*.mdb, *.accdb) - UsageCount=3 Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb) - UsageCount=3 Microsoft Access Text Driver (*.txt, *.csv) - UsageCount=3 SQL Server Native Client 10.0 - UsageCount=1 SQL Server Native Client 11.0 - UsageCount=1 Microsoft Access dBASE Driver (*.dbf, *.ndx, *.mdx) - UsageCount=3 Microsoft Access Paradox Driver (*.db) - UsageCount=3 MySQL ODBC 5.3 ANSI Driver - UsageCount=1 MySQL ODBC 5.3 Unicode Driver - UsageCount=1 ODBC Driver 11 for SQL Server - UsageCount=1 Lianja ODBC Driver - CPTimeout=60 Microsoft Visual FoxPro Driver - UsageCount=1 Microsoft Visual FoxPro-Treiber - UsageCount=1 Driver para o Microsoft Visual FoxPro - UsageCount=1 Microsoft FoxPro VFP Driver (*.dbf) - UsageCount=1 33.6 Print List of ODBC Data Sources The next example print a list of ODBC data sources. See "ODBC test 2" + nl pODBC = odbc_init() See "Data Sources " + nl see odbc_datasources(pODBC) odbc_close(pODBC) Output: ODBC test 2 Data Sources Excel Files - Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb) MS Access Database - Microsoft Access Driver (*.mdb, *.accdb) Customer - Microsoft Access Driver (*.mdb) IdCardData - Microsoft Access Driver (*.mdb) MyProjectData2 - Microsoft Access Driver (*.mdb) MyData - Microsoft Access Driver (*.mdb) MonprojetData - Microsoft Access Driver (*.mdb) dBASE Files - Microsoft Access dBASE Driver (*.dbf, *.ndx, *.mdx) myvfpdata - Microsoft Visual FoxPro Driver FACTORYDATA - Microsoft Access Driver (*.mdb) TRAININGSYSDATA - Microsoft Access Driver (*.mdb) RVCSYSDATASQLDB - SQL Server Native Client 11.0 PWCTRVCDATA - Microsoft Access Driver (*.mdb) MyCompany - Microsoft Access Driver (*.mdb) HCS - Microsoft Access Driver (*.mdb) HCS2 - Microsoft Access Driver (*.mdb, *.accdb) MyProjectData - Microsoft Access Driver (*.mdb) Xtreme Sample Database 2008 - Microsoft Access Driver (*.mdb) Lianja_Southwind - Lianja ODBC Driver Visual FoxPro Database - Microsoft Visual FoxPro Driver Visual FoxPro Tables - Microsoft Visual FoxPro Driver 33.6. Print List of ODBC Data Sources 176
- 200. Ring Documentation, Release1.4.1 33.7 odbc_connect() Function We can connect to the database using the odbc_connect() function. Syntax: odbc_connect(ODBC Handle, cConnectionString) 33.8 odbc_disconnect() Function We can close the connection to the database using the odbc_disconnect() function. Syntax: odbc_disconnect(ODBC Handle) 33.9 Open and Close Connection The next example connect to the database then close the connection See "ODBC test 3" + nl pODBC = odbc_init() See "Connect to database" + nl see odbc_connect(pODBC,"DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl See "disconnect" + nl odbc_disconnect(pODBC) See "Close database..." + nl odbc_close(pODBC) Output: ODBC test 3 Connect to database 1 disconnect Close database... 33.10 odbc_execute() Function We can execute SQL Statements on the database using the odbc_execute() function. Syntax: odbc_execute(ODBC Handle, cSQLStatement) 33.11 odbc_colcount() Function We can get columns count in the query result using the odbc_colcount() function. Syntax: 33.7. odbc_connect() Function 177
- 201. Ring Documentation, Release1.4.1 odbc_colcount(ODBC Handle) ---> Columns Count as Number 33.12 odbc_fetch() Function We can fetch a row from the query result using the odbc_fetch() function. Syntax: odbc_fetch(ODBC Handle) 33.13 odbc_getdata() Function We can get column value from the fetched row using the odbc_getdata() function. Syntax: odbc_getdata(ODBC Handle, nColumnNumber) ---> Column Value 33.14 Execute Query and Print Result The next example execute query then print the query result. See "ODBC test 4" + nl pODBC = odbc_init() See "Connect to database" + nl see odbc_connect(pODBC,"DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl See "Select data" + nl see odbc_execute(pODBC,"select * from person") + nl nMax = odbc_colcount(pODBC) See "Columns Count : " + nMax + nl while odbc_fetch(pODBC) See "Row data:" + nl for x = 1 to nMax see odbc_getdata(pODBC,x) + " - " next end See "Close database..." + nl odbc_disconnect(pODBC) odbc_close(pODBC) 33.15 odbc_tables() Function We can get a list of tables inside the database using the odbc_tables() function. We can access the result of this function as we get any query result. Syntax: odbc_tables(ODBC Handle) Example: 33.12. odbc_fetch() Function 178
- 202. Ring Documentation, Release1.4.1 See "ODBC test - Get Database Tables" + nl pODBC = odbc_init() See "Connect to database" + nl odbc_connect(pODBC,"DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl See "Select data" + nl odbc_tables(pODBC) + nl nMax = odbc_colcount(pODBC) See "Columns Count : " + nMax + nl while odbc_fetch(pODBC) for x = 1 to nMax see odbc_getdata(pODBC,x) if x != nMax see " - " ok next See nl end See "Close database..." odbc_disconnect(pODBC) odbc_close(pODBC) Output: ODBC test - Get Database Tables Connect to database Select data Columns Count : 5 .test - NULL - Customer - TABLE - NULL .test - NULL - employee - TABLE - NULL .test - NULL - person - TABLE - NULL .test - NULL - tel - TABLE - NULL Close database... 33.16 odbc_columns() Function We can get a list of columns inside the table using the odbc_columns() function. Syntax: odbc_columns(ODBC Handle, cTableName) Example: See "ODBC test - Get Table Columns" + nl pODBC = odbc_init() See "Connect to database" + nl odbc_connect(pODBC,"DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl See "Get Columns inside the Person Table" + nl odbc_columns(pODBC,"person") + nl while odbc_fetch(pODBC) see odbc_getdata(pODBC,4) + nl end See "Close database..." + nl odbc_disconnect(pODBC) odbc_close(pODBC) Output: 33.16. odbc_columns() Function 179
- 203. Ring Documentation, Release1.4.1 ODBC test - Get Table Columns Connect to database Get Columns inside the Person Table FIRST LAST STREET CITY STATE ZIP HIREDATE MARRIED AGE SALARY NOTES Close database... 33.17 odbc_autocommit() Function We can enable or disable the auto commit feature using the odbc_autocommit() function. Syntax: odbc_autocommit(ODBC Handle, lStatus) # lStatus can be True or False 33.18 odbc_commit() Function We can commit updates to the database using the odbc_commit() function. Syntax: odbc_commit(ODBC Handle) 33.19 odbc_rollback() Function We can rollback updates to the database using the odbc_rollback() function. Syntax: odbc_rollback(ODBC Handle) 33.20 Transactions and Using Commit and Rollback Example: See "ODBC Test - Transactions and using Commit and Rollback" + nl pODBC = odbc_init() See "Connect to database" + nl see odbc_connect(pODBC,"DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl see "insert data..." + nl odbc_autocommit(pODBC,0) 33.17. odbc_autocommit() Function 180
- 204. Ring Documentation, Release1.4.1 for x = 1 to 10000 odbc_execute(pODBC,"insert into tel values (" + x + ",'mahmoud')") next for x = 10001 to 15000 odbc_execute(pODBC,"insert into tel values (" + x + ",'samir')") next odbc_commit(pODBC) for x = 15001 to 20000 odbc_execute(pODBC,"insert into tel values (" + x + ",'fayed')") next ODBC_ROLLBACK(pODBC) odbc_execute(pODBC,"insert into tel values (" + x + ",'fayed')") odbc_commit(pODBC) See "Close database..." + nl odbc_disconnect(pODBC) odbc_close(pODBC) Output: ODBC Test - Transactions and using Commit and Rollback Connect to database 1 insert data... Close database... 33.21 Save and Restore images The next example save an image inside the database See "ODBC test - Save image in the database" + nl pODBC = odbc_init() See "Connect to database" + nl see odbc_connect(pODBC,"DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl see "Read Image File..." + nl cFile = str2hex(read("testsmahmoud.jpg")) see "size " + len(CFile)+nl see "Save image in the database..." + nl stmt = "insert into tel values (20000,'mahmoud','" + cFile + "');" odbc_execute(pODBC,stmt) See "Close database..." + nl odbc_disconnect(pODBC) odbc_close(pODBC) The next example restore the image from the database See "ODBC Test - Restore image from the database" + nl pODBC = odbc_init() See "Connect to database" + nl see odbc_connect(pODBC,"DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl See "Select data" + nl see odbc_execute(pODBC,"select * from tel") + nl nMax = odbc_colcount(pODBC) See "Columns Count : " + nMax + nl while odbc_fetch(pODBC) 33.21. Save and Restore images 181
- 205. Ring Documentation, Release1.4.1 See "Write image file" + nl write("testsgreat.jpg",hex2str( odbc_getdata(pODBC,3) ) ) end See "Close database..." + nl odbc_disconnect(pODBC) odbc_close(pODBC) 33.21. Save and Restore images 182
- 206. CHAPTER THIRTYFOUR MYSQL FUNCTIONS In thischapter we are going to learn about the MySQL functions provided by the Ring programming language. • MySQL_Info() • MySQL_Init() • MySQL_Error() • MySQL_Connect() • MySQL_Close() • MySQL_Query() • MySQL_Insert_ID() • MySQL_Result() • MySQL_Next_Result() • MySQL_Columns() • MySQL_Result2() • MySQL_Escape_String() • MySQL_AutoCommit() • MySQL_Commit() • MySQL_Rollback() Before using the next function load the mysqllib.ring library load "mysqllib.ring" # Use MySQL functions 34.1 MySQL_Info() Function We can get the MySQL Client version using the MySQL_Info() function. Syntax: MySQL_Info() ---> string contains the MySQL Client version Example: see "MySQL Client Version : " + mysql_info() 183
- 207. Ring Documentation, Release1.4.1 Output: MySQL Client Version : 6.1.5 34.2 MySQL_Init() Function We can start using MySQL Client through the MySQL_Init() function. Syntax: MySQL_Init() ---> MySQL Handle 34.3 MySQL_Error() Function We can get the error message from the MySQL Client using the MySQL_Error() function. Syntax: MySQL_Error(MySQL Handle) ---> Error message as string 34.4 MySQL_Connect() Function We can connect to the MySQL database server using the MySQL_Connect() function. Syntax: MySQL_Connect(MySQL Handle, cServer, cUserName, cPassword) ---> lStatus 34.5 MySQL_Close() Function We can close the connection to the MySQL database using the MySQL_Close() function Syntax: MySQL_Close(MySQL Handle) 34.6 MySQL_Query() Function We can execute SQL queries using the MySQL_Query() function Syntax: MySQL_Query(MySQL Handle, cSQLQuery) 34.2. MySQL_Init() Function 184
- 208. Ring Documentation, Release1.4.1 34.7 Create Database The next example connect to MySQL Server then create new database. See "MySQL Test - Create Database" + nl con = mysql_init() See "Connect" + nl if mysql_connect(con,"localhost","root","root") = 0 see "Cann't connect" + nl see "Error : " + mysql_error(con) + nl mysql_close(con) bye ok See "Create Database..." + nl mysql_query(con,"CREATE DATABASE mahdb") See "Close Connection" + nl mysql_close(con) Output: MySQL Test - Create Database Connect Create Database... Close Connection 34.8 Create Table and Insert Data The next example create new table and insert records func main see "Create Table and Insert Records" + nl con = mysql_init() see "Connect" + nl if mysql_connect(con, "localhost", "root", "root","mahdb") = 0 system_error(con) ok see "Drop table" + nl if mysql_query(con, "DROP TABLE IF EXISTS Employee") system_error(con) ok see "Create table" + nl if mysql_query(con, "CREATE TABLE Employee(Id INT, Name TEXT, Salary INT)") system_error(con) ok see "Insert data" + nl if mysql_query(con, "INSERT INTO Employee VALUES(1,'Mahmoud',15000)") system_error(con) ok if mysql_query(con, "INSERT INTO Employee VALUES(2,'Samir',16000)") system_error(con) ok if mysql_query(con, "INSERT INTO Employee VALUES(3,'Fayed',17000)") 34.7. Create Database 185
- 209. Ring Documentation, Release1.4.1 system_error(con) ok see "Close connection" + nl mysql_close(con) func system_error con see mysql_error(con) mysql_close(con) bye Output: Create Table and Insert Records Connect Drop table Create table Insert data Close connection 34.9 MySQL_Insert_ID() Function We can get the inserted row id using the MySQL_Insert_ID() function Syntax: MySQL_Insert_ID() ---> Inserted row id as number Example: con = mysql_init() see "connect to database" + nl mysql_connect(con,"localhost","root","root","mahdb") see "drop table" + nl mysql_query(con, "DROP TABLE IF EXISTS Customers") see "create table" + nl mysql_query(con, "CREATE TABLE Customers(Id INT PRIMARY KEY AUTO_INCREMENT, Name TEXT)") see "insert record" + nl mysql_query(con, "INSERT INTO Customers(Name) VALUES('Mahmoud')") see "insert record" + nl mysql_query(con, "INSERT INTO Customers(Name) VALUES('Samir')") see "insert record" + nl mysql_query(con, "INSERT INTO Customers(Name) VALUES('Fayed')") see "insert record" + nl mysql_query(con, "INSERT INTO Customers(Name) VALUES('Test 2015')") see "inserted row id : " + mysql_insert_id(con) + nl see "close database" + nl mysql_close(con) Output: connect to database drop table create table insert record insert record insert record insert record inserted row id : 4 close database 34.9. MySQL_Insert_ID() Function 186
- 210. Ring Documentation, Release1.4.1 34.10 MySQL_Result() Function We can get the query result (data without column names) using the MySQL_Result() function. Syntax: MySQL_Result(MySQL Handle) ---> List contains the query result 34.11 MySQL_Next_Result() Function We can move to the next query result using the MySQL_Next_Result() function. We use this function when we have multiple SQL statements in the same query. Syntax: MySQL_Next_Result(MySQL Handle) 34.12 Print Query Result The next example execute a query on the database then print the result. con = mysql_init() see "Connect to database" + nl mysql_connect(con, "localhost", "root", "root","mahdb") see "Execute Query" + nl mysql_query(con, "SELECT Name FROM Employee WHERE Id=1;"+ "SELECT Name FROM Employee WHERE Id=3") see "Print Result" + nl see mysql_result(con) mysql_next_result(con) see mysql_result(con) see "close database" + nl mysql_close(con) Output: Connect to database Execute Query Print Result Mahmoud Fayed close database 34.13 MySQL_Columns() Function We can get a list of columns names using the MySQL_Columns() function. Syntax: 34.10. MySQL_Result() Function 187
- 211. Ring Documentation, Release1.4.1 MySQL_Columns(MySQL Handle) ---> List contains columns information Example: con = mysql_init() see "Connect to database" + nl mysql_connect(con, "localhost", "root", "root","mahdb") see "Execute Query" + nl mysql_query(con, "SELECT * FROM Employee") see "Result" + nl see mysql_columns(con) see "Close database" + nl mysql_close(con) Output: Connect to database Execute Query Result Id 11 3 32768 Name 65535 252 16 Salary 11 3 32768 Close database 34.14 MySQL_Result2() Function Instead of using MySQL_Result() to get the result data without columns names, we can use the MySQL_Result2() to get all of the column names then the query result in one list. Syntax: MySQL_Result2(MySQL Handle) ---> List (query result starts with columns names) Example: con = mysql_init() see "Connect to database" + nl mysql_connect(con, "localhost", "root", "root","mahdb") see "Execute Query" + nl mysql_query(con, "SELECT * FROM Employee") see "Print Result" + nl see mysql_result2(con) see "Close database" + nl mysql_close(con) Output: 34.14. MySQL_Result2() Function 188
- 212. Ring Documentation, Release1.4.1 Connect to database Execute Query Print Result Id Name Salary 1 Mahmoud 15000 2 Samir 16000 3 Fayed 17000 Close database 34.15 MySQL_Escape_String() Function We can store binary data and special characters in the database after processing using MySQL_Escape_String() func- tion Syntax: MySQL_Escape_String(MySQL Handle, cString) ---> String after processing 34.16 Save Image inside the database Example: See "Read file" + nl cFile = read("testsmahmoud.jpg") con = mysql_init() See "Connect to database..." + nl mysql_connect(con, "localhost", "root", "root","mahdb") See "Escape string..." + nl cFile = mysql_escape_string(con,cFile) stmt = "INSERT INTO photo(id, data) VALUES(1, '" + cFile + "')" See "Insert data..." + nl mysql_query(con,stmt) See "Close database..." + nl mysql_close(con) Output: Read file Connect to database... Escape string... Insert data... Close database... 34.15. MySQL_Escape_String() Function 189
- 213. Ring Documentation, Release1.4.1 34.17 Restore Image From The Database Example: con = mysql_init() See "Connect to database..." + nl mysql_connect(con, "localhost", "root", "root","mahdb") See "Read data from database..." + nl mysql_query(con,"SELECT data FROM photo WHERE id=1") See "Write new file" + nl result = mysql_result(con) write("testsmahmoud2.jpg",result[1][1]) See "Close database..." + nl mysql_close(con) Output: Connect to database... Read data from database... Write new file Close database... 34.18 MySQL_AutoCommit() Function We can enable or disable the auto commit feature using the MySQL_AutoCommit() function. Syntax: MySQL_AutoCommit(MySQL Handle, lStatus) # lstatus can be True/False 34.19 MySQL_Commit() Function We can commit updates to the database using the MySQL_Commit() function. Syntax: MySQL_Commit(MySQL Handle) 34.20 MySQL_Rollback() Function We can rollback updates to the database using the MySQL_Rollback() function. Syntax: MySQL_Rollback(MySQL Handle) 34.21 Transaction Example The next example presents the usage of MySQL_Autocommit(), MySQL_Commit() & MySQL_RollBack() functions. Example: 34.17. Restore Image From The Database 190
- 214. Ring Documentation, Release1.4.1 func main con = mysql_init() see "Connect" + nl if mysql_connect(con, "localhost", "root", "root","mahdb") = 0 system_error(con) ok see "Drop table" + nl if mysql_query(con, "DROP TABLE IF EXISTS Employee2") system_error(con) ok see "Create table" + nl if mysql_query(con, "CREATE TABLE Employee2(Id INT, Name TEXT, Salary INT)") system_error(con) ok see "Insert data" + nl if mysql_query(con, "INSERT INTO Employee2 VALUES(1,'Mahmoud',15000)") system_error(con) ok if mysql_query(con, "INSERT INTO Employee2 VALUES(2,'Samir',16000)") system_error(con) ok if mysql_query(con, "INSERT INTO Employee2 VALUES(3,'Fayed',17000)") system_error(con) ok mysql_autocommit(con,False) mysql_query(con, "INSERT INTO Employee2 VALUES(4,'Ahmed',5000)") mysql_query(con, "INSERT INTO Employee2 VALUES(5,'Ibrahim',50000)") mysql_query(con, "INSERT INTO Employee2 VALUES(6,'Mohammed',50000)") See "Save transaction (y/n) " give nChoice if upper(nChoice) = "Y" mysql_commit(con) else mysql_rollback(con) ok see "Close connection" + nl mysql_close(con) func system_error con see mysql_error(con) mysql_close(con) bye Output: Connect Drop table Create table Insert data Save transaction (y/n) y Close connection 34.21. Transaction Example 191
- 215. CHAPTER THIRTYFIVE SQLITE FUNCTIONS In thischapter we will learn about using the SQLite database in the Ring programming language. Before using the next function load the sqlitelib.ring library load "sqlitelib.ring" # Use SQLite functions 35.1 sqlite_init() function Syntax: sqlite_init() ---> SQLite Object 35.2 sqlite_open() function Syntax: sqlite_open(SQLite Object,cFileName) 35.3 sqlite_execute() function Syntax: sqlite_exexute(SQLite Object,cSQLStatement) 35.4 sqlite_close() function Syntax: sqlite_close(SQLite Object) 192
- 216. Ring Documentation, Release1.4.1 35.5 Example The next code create a SQLite database, add new records then display the data. oSQLite = sqlite_init() sqlite_open(oSQLite,"mytest.db") sql = "CREATE TABLE COMPANY(" + "ID INT PRIMARY KEY NOT NULL," + "NAME TEXT NOT NULL," + "AGE INT NOT NULL," + "ADDRESS CHAR(50)," + "SALARY REAL );" sqlite_execute(oSQLite,sql) sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (1, 'Mahmoud', 29, 'Jeddah', 20000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (2, 'Ahmed', 27, 'Jeddah', 15000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (3, 'Mohammed', 31, 'Egypt', 20000.00 );" + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (4, 'Ibrahim', 24, 'Egypt ', 65000.00 );" sqlite_execute(oSQLite,sql) aResult = sqlite_execute(oSQLite,"select * from COMPANY") for x in aResult for t in x see t[2] + nl next next see copy("*",50) + nl for x in aResult see x["name"] + nl next sqlite_close(oSQLite) Output: 1 Mahmoud 29 Jeddah 20000.0 2 Ahmed 27 Jeddah 15000.0 3 Mohammed 31 Egypt 20000.0 4 35.5. Example 193
- 217. Ring Documentation, Release1.4.1 Ibrahim 24 Egypt 65000.0 ************************************************** Mahmoud Ahmed Mohammed Ibrahim 35.5. Example 194
- 218. CHAPTER THIRTYSIX SECURITY AND INTERNETFUNCTIONS This chapter contains the security and internet functions provided by the Ring programming language for Hashing, Encryption & Decryption. Before using the next function load the openssllib.ring library load "openssllib.ring" # Use OpenSSL functions • MD5() • SHA1() • SHA256() • SHA512() • SHA384() • SHA224() • Encrypt() • Decrypt() • Randbytes() Before using the next function load the internetlib.ring library load "internetlib.ring" # Use the Internet functions • Download() • SendEmail() 36.1 MD5() Function We can calculate the MD5 hash using the MD5() Function Syntax: MD5(cString) ---> String contains the MD5 hash of the string cString Example: see "md5('happy') = " + md5("happy") + nl + "md5('Hello') = " + md5("Hello") + nl 195
- 219. Ring Documentation, Release1.4.1 Output: md5('happy') = 56ab24c15b72a457069c5ea42fcfc640 md5('Hello') = 8b1a9953c4611296a827abf8c47804d7 36.2 SHA1() Function We can calculate the SHA1 hash using the SHA1() Function Syntax: SHA1(cString) ---> String contains the SHA1 hash of the string cString Example: see "sha1('hello') : " + sha1("hello") + nl + "sha1('apple') : " + sha1("apple") + nl Output: sha1('hello') : aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d sha1('apple') : d0be2dc421be4fcd0172e5afceea3970e2f3d940 36.3 SHA256() Function We can calculate the SHA256 hash using the SHA256() Function Syntax: SHA256(cString) ---> String contains the SHA256 hash of the string cString Example: see "sha256('hello') : " + sha256("hello") + nl + "sha256('apple') : " + sha256("apple") + nl Output: sha256('hello') : 2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824 sha256('apple') : 3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b 36.4 SHA512() Function We can calculate the SHA512 hash using the SHA512() Function Syntax: SHA512(cString) ---> String contains the SHA512 hash of the string cString Example: see "sha512('hello') : " + sha512("hello") + nl + "sha512('apple') : " + sha512("apple") + nl + "sha512('hello world') : " + sha512("hello world") + nl 36.2. SHA1() Function 196
- 220. Ring Documentation, Release1.4.1 Output: sha512('hello') : 9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673c a72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043 sha512('apple') : 844d8779103b94c18f4aa4cc0c3b4474058580a991fba85d3ca698a0bc9e52 c5940feb7a65a3a290e17e6b23ee943ecc4f73e7490327245b4fe5d5efb590feb2 sha512('hello world') : 309ecc489c12d6eb4cc40f50c902f2b4d0ed77ee511a7c7a9bcd3ca8 6d4cd86f989dd35bc5ff499670da34255b45b0cfd830e81f605dcf7dc5542e93ae9cd76f 36.5 SHA384() Function We can calculate the SHA384 hash using the SHA384() Function Syntax: SHA384(cString) ---> String contains the SHA384 hash of the string cString Example: see "sha384('hello') : " + sha384("hello") + nl + "sha384('apple') : " + sha384("apple") + nl + "sha384('hello world') : " + sha384("hello world") + nl Output: sha384('hello') : 59e1748777448c69de6b800d7a33bbfb9ff1b463e44354c3553bcdb9c666fa 90125a3c79f90397bdf5f6a13de828684f sha384('apple') : 3d8786fcb588c93348756c6429717dc6c374a14f7029362281a3b21dc10250 ddf0d0578052749822eb08bc0dc1e68b0f sha384('hello world') : fdbd8e75a67f29f701a4e040385e2e23986303ea10239211af907fcb b83578b3e417cb71ce646efd0819dd8c088de1bd 36.6 SHA224() Function We can calculate the SHA224 hash using the SHA224() Function Syntax: SHA224(cString) ---> String contains the SHA224 hash of the string cString Example: see "sha224('hello') : " + sha224("hello") + nl + "sha224('apple') : " + sha224("apple") + nl + "sha224('hello world') : " + sha224("hello world") + nl Output: sha224('hello') : ea09ae9cc6768c50fcee903ed054556e5bfc8347907f12598aa24193 sha224('apple') : b7bbfdf1a1012999b3c466fdeb906a629caa5e3e022428d1eb702281 sha224('hello world') : 2f05477fc24bb4faefd86517156dafdecec45b8ad3cf2522a563582b 36.7 Encrypt() Function We can use the Encrypt() function to encrypts the data using the Blowfish algorithm. 36.5. SHA384() Function 197
- 221. Ring Documentation, Release1.4.1 Syntax: Encrypt(cString, cKey, cIV) ---> Encrypted string 36.8 Decrypt() Function We can use the Decrypt() function to decrypt the data encrypted using the Encrypt() function. Syntax: Decrypt(cCipher, cKey, cIV) ---> Decrypted string 36.9 Encryption and Decryption Example The next example demonstrates how to use the Encrypt() and Decrypt() functions. These functions use the Blowfish algorithm. See "Enter a string : " give cStr list = 0:15 cKey="" for x in list cKey += char(x) next list = 1:8 cIV = "" for x in list cIV += char(x) next cStr = Encrypt(cStr,cKey,cIV) See "Cipher Text : " + cStr + nl + "Plain Text : " + Decrypt(cStr,cKey,cIV) + nl 36.10 File Hash The next example demonstrates how to calculate the hash functions for files cStr = read("myapp.exe") see "Size : " + len(cStr) + nl + "md5 : " + md5(cStr) + nl + "sha1 : " + sha1(cStr) + nl + "sha256 : " + sha256(cStr) + nl + "sha224 : " + sha224(cStr) + nl + "sha384 : " + sha384(cStr) + nl + "sha512 : " + sha512(cStr) + nl Output: Size : 58079876 md5 : 762eee15d8d2fd73b71ea52538b28667 sha1 : 9212c0c7258bad89a62bd239e1358a9276a9d070 sha256 : 7d6724e69b6c553da749ba31b6185dddc965129b64d9e9bf3de88f67df3b1cdc sha224 : 5a9c8a7d662bce4f880ba94f90a79362b672528b9efd5abc718c7a3d sha384 : 18e23f973abedbeb3981c423f12aeadecf96f9c6fb28aeabe3be4c484f8540afcc3861b b370ce2b59cf3c99c130b856b sha512 : da3d5e997d06f8b2a7a9964b77f7d82eedb76b245c611082c1639f83f51d83880bcd08f cd53dcab1167bdca0b82fec5071971ac17c76479d76985ced4ab0d18e 36.8. Decrypt() Function 198
- 222. Ring Documentation, Release1.4.1 36.11 Randbytes() Function We can generate a string of pseudo-random bytes using the Randbytes() function. Syntax: Randbytes(nSize) ---> String contains random bytes (bytes count = nSize) Example: salt = randbytes(32) password = "SecretPassWord@$%123" see salt + nl see sha256("test" + salt) + nl 36.12 Download() Function Syntax: Download(cURL) ---> String contains the server response Example: cStr= download("http://doublesvsoop.sourceforge.net/") see cStr write("download.txt",cStr) 36.13 SendEmail() Function Syntax: SendEmail(cSMTPServer,cEmail,cPassword,cSender,cReceiver,cCC,cTitle,cContent) Example: See "Send email..." + nl sendemail("smtp://smtp.gmail.com:587", "email@gmail.com", "password", "email@gmail.com", "somebody@yahoo.com", "somebodyelse@yahoo.com", "Sending email from Ring", "Hello How are you? Are you fine? Thank you! Greetings, Mahmoud") see "Done.." + nl 36.11. Randbytes() Function 199
- 223. CHAPTER THIRTYSEVEN OBJECT ORIENTED PROGRAMMING(OOP) In this chapter we are going to learn how to use the Object-Oriented programming paradigm inside the Ring program- ming language. We will learn about • Classes and Objects • Access Objects Using Braces • Composition • Setter and Getter • Private Attributes and Methods • Operator Overloading • Inheritance • Dynamic Attributes • Packages • Printing Objects • Find() and List of Objects • Sort() and List of Objects • Using Self.Attribute and Self.Method() • Using This.Attribute and This.Method() 37.1 Classes and Objects We can define new classes using the next syntax Syntax: Class <Class Name> [From|<|: <Parent Class Name>] [Attributes] [Methods] [Private [Attributes] [Methods] ] 200
- 224. Ring Documentation, Release1.4.1 And we can create objects using the next syntax Syntax: New <Object Name> [ (init method parameters) ] | [ { access object data and methods } ] ---> Object Example: New point { x=10 y=20 z=30 print() } Class Point x y z func print see x + nl + y + nl + z + nl Note: We can use { } to access object data and methods. Tip: we can declare the class attributes directly after the class name. Output: 10 20 30 We can rewrite the same program in another style New point # create new object using the point class { # access the new object attributes and methods x = 10 # set the x attribute to 10 y = 20 # set the y attribute to 20 z = 30 # set the z attribute to 30 print() # call the print method } # end of object access Class Point # define the Point class x y z # the class contains three attributes x, y & z func print # define the print method see x + nl + # print the x attribute y + nl + # print the y attribute z + nl # print the z attribute Also we can write the same program in another way P1 = New Point P1.x = 10 P1.y = 20 P1.z = 30 P1.Print() Class Point x y z func print see x + nl + y + nl + z + nl Note: we can use the dot operator after the object name to access object members. Also we can write the same program in another way new point { print() } Class Point x = 10 y = 20 z = 30 func print see x + nl + y + nl + z + nl 37.1. Classes and Objects 201
- 225. Ring Documentation, Release1.4.1 Note: we can set the default values for the class attributes when we declare them. Also we can write the same program in another way new point(10,20,30) Class Point x y z func init p1,p2,p3 x=p1 y=p2 z=p3 print() func print see x + nl + y + nl + z + nl Note: we can call the init method directly using () when we create new objects Also we can write the same program in another way new point( [ :x = 10 , :y = 20 , :z = 30 ] ) Class Point x y z func init aPara x = aPara[:x] y = aPara[:y] z = aPara[:z] print() func print see x + nl + y + nl + z + nl Tip: using Hash for passing method parameters enable us to create optional parameters and change the order of parameters when adding them to the Hash. 37.2 Access Objects Using Braces We can access the object at any time using braces { } Inside the braces we can use the object attributes and methods directly This can be done when we create the object using the New keyword or at any time using the next syntax ObjectName { access object data and methods } Example: See "Creating the Object" + nl o1 = new Point See "Using the Object" + nl o1 { x=5 y=15 z=25 print() } Class Point x y z func print see x + nl + y + nl + z We can use braces to access objects when we call functions or methods Example: o1 = new Point print( o1 { x=10 y=20 z=30 } ) func print object see object.x + nl + object.y + nl + 37.2. Access Objects Using Braces 202
- 226. Ring Documentation, Release1.4.1 object.z Class Point x y z We can mix between using braces and the dot operator to access the object in the same expression. Example: o1 = new Point O1 { x=10 y=20 z=30 }.print() Class Point x y z func print see x + nl + y + nl + z 37.3 Composition The object may contains other objects as attributes. Using braces to access objects can be nested. Example: R1 = New Rectangle { Name = "Rectangle 1" P1 { X = 10 Y = 20 } P2 { X = 200 Y = 300 } Color = "Blue" } see "Name : " + R1.Name + nl + "Color: " + R1.Color + nl + "P1 : (" + R1.P1.X + "," + R1.P1.Y + ")" + nl + "P2 : (" + R1.P2.X + "," + R1.P2.Y + ")" Class Rectangle name color p1 = new Point p2 = new Point Class Point x y Output: 37.3. Composition 203
- 227. Ring Documentation, Release1.4.1 Name : Rectangle 1 Color: Blue P1 : (10,20) P2 : (200,300) 37.4 Setter and Getter We can define methods to be used when we set and get object attributes. Syntax: Class ClassName AttributeName ... Func SetAttributeName ... Func GetAttributeName ... Example: o1 = new person o1.name = "Mahmoud" see o1.name + nl o1 { name = "Ahmed" see name } Class Person name family = "Fayed" func setname value see "Message from SetName() Function!" + nl name = value + " " + family func getname see "Message from GetName() Function!" + nl return "Mr. " + name Output: Message from SetName() Function! Message from GetName() Function! Mr. Mahmoud Fayed Message from SetName() Function! Message from GetName() Function! Mr. Ahmed Fayed 37.5 Private Attributes and Methods We can define private attributes and methods after the keyword private inside the class body 37.4. Setter and Getter 204
- 228. Ring Documentation, Release1.4.1 Example: o1 = new person { name = "Test" age = 20 print() o1.printsalary() } try see o1.salary catch see cCatchError + nl done try o1.increasesalary(1000) catch see cCatchError + nl done Class Person name age func print see "Name : " + name + nl + "Age : " + age + nl func printsalary see "Salary : " + salary + nl private salary = 15000 func increasesalary x salary += x Output: Name : Test Age : 20 Salary : 15000 Error (R27) : Using private attribute from outside the class : salary Error (R26) : Calling private method from outside the class : increasesalary 37.6 Operator Overloading We can add the operator method to our class to enable using operators with the class objects. Syntax: Class ClassName ... 37.6. Operator Overloading 205
- 229. Ring Documentation, Release1.4.1 Func operator cOperator,Para ... The function operator takes two paramters, the first represent the operator and the second represent the second param- eter after the operator. Example: o1 = new point { x = 10 y = 10 print("P1 : ") } o2 = new point { x = 20 y = 40 print("P2 : ") } o3 = o1 + o2 o3.print("P1+P2 : ") class point x y func operator cOperator,Para result = new point switch cOperator on "+" result.x = x + Para.x result.y = y + Para.y on "-" result.x = x - Para.x result.y = y - Para.y off return result func print cPoint see cPoint + "X : " + x + " Y : " + y + nl Output: P1 : X : 10 Y : 10 P2 : X : 20 Y : 40 P1+P2 : X : 30 Y : 50 37.7 Inheritance We can create class from another class in the class definition using the keyword from. Syntax: Class <Class Name> [From <Parent Class Name>] We can call a method in the parent class from the child class using the super object. Syntax: func methodname ... super.methodname() ... Example: 37.7. Inheritance 206
- 230. Ring Documentation, Release1.4.1 Func main e1 = new Employee { Name = "test" age = 20 job = "programmer" salary = 20000000 print() } Class Human Name Age func print see "Name : " + name + nl + "Age : " + age + nl Class Employee from Human Job Salary func print super.print() see "Job : " + job + nl + "Salary : " + salary + nl Output: Name : test Age : 20 Job : programmer Salary : 20000000 37.8 Dynamic Attributes We can write instructions after the class name to be executed when we create new objects Example: o1 = new dynamicClass see o1.var5 + nl # output 5 Class DynamicClass for x = 1 to 10 cStr = "var" + x + " = " + x eval(cStr) next Tip: in the previous example var1, var2, ..., var10 will be defined as attributes. Tip: The problem with the previous example is that x and cStr will be defined as attributes too! Note: we can write class definitions inside a string then using eval() we can execute the string to define the classes 37.9 Packages We can create a package (a group of classes under a common name) using the next syntax 37.8. Dynamic Attributes 207
- 231. Ring Documentation, Release1.4.1 package PackageName Class Class1 ... Class Class2 ... Class Class3 ... ... Example o1 = new System.output.console o1.print("Hello World") Package System.Output Class Console Func Print cText see cText + nl Note: we can use the dot operator as part of the package name Instead of typing the long name PackageName.ClassName we can use the import command When we import a package, we can use any class inside this package directly. Example import system.output o1 = new console { print("Hello World") } Package System.Output Class Console Func Print cText see cText + nl 37.10 Printing Objects We can print the object state (attributes and values) using the see command. Example: see new point { x=10 y=20 z=30 } class point x y z Output: x: 10.000000 y: 20.000000 z: 30.000000 37.11 Find() and List of Objects We can use the find() function to search inside a list of objects. Syntax: 37.10. Printing Objects 208
- 232. Ring Documentation, Release1.4.1 Find(List,ItemValue,nColumn,cAttribute) ---> Item Index Example: myList1 = [new Company {position=3 name="Mahmoud" symbol="MHD"}, new Company {position=2 name="Bert" symbol="BRT"}, new Company {position=1 name="Ring" symbol="RNG"} ] see find(mylist1,"Bert",1,"name") + nl see find(mylist1,"Ring",1,"name") + nl see find(mylist1,"Mahmoud",1,"name") + nl see find(mylist1,"RNG",1,"symbol") + nl see find(mylist1,"MHD",1,"symbol") + nl see find(mylist1,"BRT",1,"symbol") + nl see find(mylist1,3,1,"position") + nl see find(mylist1,1,1,"position") + nl see "Other" + nl see find(mylist1,"test",1,"name") + nl see find(mylist1,"test",0,"name") + nl see find(mylist1,"test",5,"name") + nl class company position name symbol Output: 2 3 1 3 1 2 1 3 Other 0 0 0 37.12 Sort() and list of objects We can sort a list of objects based on an object attribute using the Sort() function. Syntax: Sort(List,nColumn,cAttribute) ---> Sorted List based on Object Attribute Example: myList1 = [ new Company {position=3 name="Mahmoud" symbol="MHD"}, new Company {position=2 name="Bert" symbol="BRT"}, new Company {position=8 name="Charlie" symbol="CHR"}, new Company {position=6 name="Easy" symbol="FEAS"}, new Company {position=7 name="Fox" symbol="EFOX"}, new Company {position=5 name="Dog" symbol="GDOG"}, new Company {position=4 name="George" symbol="DGRG"}, 37.12. Sort() and list of objects 209
- 233. Ring Documentation, Release1.4.1 new Company {position=1 name="Ring" symbol="RNG"} ] see sort(mylist1,1,"name") see copy("*",70) + nl see sort(mylist1,1,"symbol") see copy("*",70) + nl see sort(mylist1,1,"position") class company position name symbol Output: position: 2.000000 name: Bert symbol: BRT position: 8.000000 name: Charlie symbol: CHR position: 5.000000 name: Dog symbol: GDOG position: 6.000000 name: Easy symbol: FEAS position: 7.000000 name: Fox symbol: EFOX position: 4.000000 name: George symbol: DGRG position: 3.000000 name: Mahmoud symbol: MHD position: 1.000000 name: Ring symbol: RNG ********************************************************************** position: 2.000000 name: Bert symbol: BRT position: 8.000000 name: Charlie symbol: CHR position: 4.000000 name: George symbol: DGRG position: 7.000000 name: Fox symbol: EFOX position: 6.000000 name: Easy symbol: FEAS position: 5.000000 name: Dog symbol: GDOG position: 3.000000 name: Mahmoud 37.12. Sort() and list of objects 210
- 234. Ring Documentation, Release1.4.1 symbol: MHD position: 1.000000 name: Ring symbol: RNG ********************************************************************** position: 1.000000 name: Ring symbol: RNG position: 2.000000 name: Bert symbol: BRT position: 3.000000 name: Mahmoud symbol: MHD position: 4.000000 name: George symbol: DGRG position: 5.000000 name: Dog symbol: GDOG position: 6.000000 name: Easy symbol: FEAS position: 7.000000 name: Fox symbol: EFOX position: 8.000000 name: Charlie symbol: CHR 37.13 Using Self.Attribute and Self.Method() Inside the class region (After the class name and before any method) and the class methods we can use self.attribute and self.method() Class Point self.x = 10 self.y = 20 self.z = 30 func print see self.x + nl + self.y + nl + self.z + nl Note: using self.attribute in the class region to define the class attribute protect the class attributes from conflict with global variables. Tip: if you typed the class attributes with self.attribute and there are a global variable with the same name it will be used and the attribute will not be defined. Check the “Scope Rules” chapter to know about the conflict between the global variable name and the attribute name Whay this may happens? Because • Because in the class region we can access global variables. 37.13. Using Self.Attribute and Self.Method() 211
- 235. Ring Documentation, Release1.4.1 • Before defining any variable, Ring try to find the variable and use it if it’s found. Note: Try to avoid the global variables, use the main function and start their names with $ Tip: In large programs protect your classes and define their members using self.attribute 37.14 Using This.Attribute and This.Method() Inside class methods we have access to the object scope directly. we don’t need to use Self.attribute or Self.method to read/write attribute and call methods. But we can use braces {} while we are inside methods to access another object, In this case the current object scope will be changed while we are inside the brace. How we can get access to our class attributes and methods while we are inside braces? This can be done using This.Attribute and This.Method() Example: new point class point x=10 y=20 z=30 print() func print new UI { display(this.x,this.y,this.z) } Class UI func display x,y,z see x + nl + y + nl + z + nl 37.14. Using This.Attribute and This.Method() 212
- 236. CHAPTER THIRTYEIGHT FUNCTIONAL PROGRAMMING In previouschapters we learned about Functions and Recursion. In this chapter we are going to learn about more Functional Programming (FP) concepts like • Pure Functions • First-class functions • Higher-order functions • Anonymous and nested functions. • Equality of functions 38.1 Pure Functions We can create pure functions (functions that doesn’t change the state) by the help of the assignment operator to copy variables (Lists & Objects) by value to create new variables instead of working on the original data that are passed to the function by reference. Example: Func Main aList = [1,2,3,4,5] aList2 = square(aList) see "aList" + nl see aList see "aList2" + nl see aList2 Func Square aPara a1 = aPara # copy the list for x in a1 x *= x next return a1 # return new list Output: aList 1 2 3 4 5 213
- 237. Ring Documentation, Release1.4.1 aList2 1 4 9 16 25 38.2 First-class Functions Functions inside the Ring programming language are first-class citizens, you can pass functions as parameters, return them as value or store them in variables. We can pass/return the function by typing the function name as literal like “FunctionName” or :FunctionName for example. We can pass/return functions using the variable that contains the function name. We can call function from variables contains the function name using the Call command Syntax: Call Variable([Parameters]) Example: Func Main see "before test2()" + nl f = Test2(:Test) see "after test2()" + nl call f() Func Test see "Message from test!" + nl Func Test2 f1 call f1() See "Message from test2!" + nl return f1 Output: before test2() Message from test! Message from test2! after test2() Message from test! 38.3 Higher-order Functions Higher-order functions are the functions that takes other functions as parameters. Example: Func Main times(5,:test) 38.2. First-class Functions 214
- 238. Ring Documentation, Release1.4.1 Func Test see "Message from the test function!" + nl Func Times nCount,F for x = 1 to nCount Call F() next Output: Message from the test function! Message from the test function! Message from the test function! Message from the test function! Message from the test function! 38.4 Anonymous and Nested Functions Anonymous Functions are functions without names that can be passed as parameters to other functions or stored in variables. Syntax: Func [Parameters] { [statements] } Example: test( func x,y { see "hello" + nl see "Sum : " + (x+y) + nl } ) new great { f1() } times(3, func { see "hello world" + nl } ) func test x call x(3,3) see "wow!" + nl func times n,x for t=1 to n call x() next Class great func f1 f2( func { see "Message from f1" + nl } ) func f2 x call x() Output: hello Sum : 6 38.4. Anonymous and Nested Functions 215
- 239. Ring Documentation, Release1.4.1 wow! Message from f1 hello world hello world hello world Example: Func Main aList = [1,2,3,4] Map (aList , func x { return x*x } ) see aList aList = [4,9,14,25] Map(aList, :myfilter ) see aList aList = [11,12,13,14] Map (aList , func x { if x%2=0 return "even" else return "odd" ok }) see aList Func myfilter x if x = 9 return "True" else return "False" ok Func Map aList,cFunc for x in aList x = call cFunc(x) next Output: 1 4 9 16 False True False False odd even odd even 38.5 Equality of functions We can test if function = function or not using the ‘=’ or ‘!=’ operators 38.5. Equality of functions 216
- 240. Ring Documentation, Release1.4.1 Example: f1 = func { see "hello" + nl } f2 = func { see "how are you?" + nl } f3 = f1 call f1() call f2() call f3() see (f1 = f2) + nl see (f2 = f3) + nl see (f1 = f3) + nl Output: hello how are you? hello 0 0 1 38.5. Equality of functions 217
- 241. CHAPTER THIRTYNINE REFLECTION AND META-PROGRAMMING Sincethe Ring programming language is a dynamic language, we can get answers about the program code and we can modify our code during the runtime. In this chapter we will learn about this and the available functions to use. 39.1 locals() Function We can get a list of variables names in the current scope using the locals() function. Syntax: locals() --> a list contains the variables names in the current scope Example: test("hello") func test cMsg see cMsg + nl x = 10 y = 20 z = 30 see locals() Output: hello cmsg x y z 39.2 globals() Function We can get a list of variables names in the global scope using the globals() function. Syntax: 218
- 242. Ring Documentation, Release1.4.1 globals() --> a list contains variables names in the global scope Example: x=10 y=20 z=30 test() func test see "message from test()" + nl + "Global Variables:" + nl see globals() Output: message from test() Global Variables: x y z 39.3 functions() Function We can get a list of functions names written in the Ring language using the functions() function. Syntax: functions() --> a list contains functions names Example: see functions() func f1 see "f1" + nl func f2 see "f2" + nl func f3 see "f3" + nl Output: f1 f2 f3 39.4 cfunctions() Function We can get a list of functions names written in the C language using the cfunctions() function. Syntax: cfunctions() --> a list contains functions names Example: 39.3. functions() Function 219
- 243. Ring Documentation, Release1.4.1 aList = cfunctions() See "Count : " + len(aList) + nl for x in aList see x + "()" + nl next Output: Count : 233 len() add() del() get() clock() ... Note: The complete list is removed from the previous output. 39.5 islocal() Function We can check if a variable is defined in the local scope or not using the islocal() function. Syntax: islocal(cVariableName) --> returns 1 if the variable is defined in the local scope returns 0 if the variable is not defined in the local scope Example: test() func test x=10 y=20 see islocal("x") + nl + islocal("y") + nl + islocal("z") + nl Output: 1 1 0 39.6 isglobal() Function We can check if a variable is defined in the global scope or not using the isglobal() function. Syntax: isglobal(cVariableName) --> returns 1 if the variable is defined in the global scope returns 0 if the variable is not defined in the global scope Example: 39.5. islocal() Function 220
- 244. Ring Documentation, Release1.4.1 x=10 y=20 test() func test see isglobal("x") + nl + isglobal("y") + nl + isglobal("z") + nl Output: 1 1 0 39.7 isfunction() Function We can check if a Ring function is defined or not using the isfunction() function. Syntax: isfunction(cFunctionName) --> returns 1 if the Ring function is defined returns 0 if the Ring function is not defined Example: see isfunction("f1") + nl + isfunction("f2") + nl + isfunction("f3") + nl func f1 see "message from f1()" + nl func f2 see "message from f2()" + nl Output: 1 1 0 39.8 iscfunction() Function We can check if a C function is defined or not using the iscfunction() function. Syntax: iscfunction(cFunctionName) --> returns 1 if the C function is defined returns 0 if the C function is not defined Example: see iscfunction("len") + nl + iscfunction("add") + nl + iscfunction("test") + nl 39.7. isfunction() Function 221
- 245. Ring Documentation, Release1.4.1 Output: 1 1 0 39.9 packages() Function We can get a list of packages names using the packages() function. Syntax: packages() --> a list contains packages names Example: See packages() Package Package1 Class class1 Func f1 Package Package2 Class class1 Func f1 Package Package3 Class class1 Func f1 Package Package4 Class class1 Func f1 Output: package1 package2 package3 package4 39.10 ispackage() Function We can check if a package is defined or not using the ispackage() function. Syntax: ispackage(cPackageName) --> returns 1 if the Package is defined returns 0 if the Package is not defined Example: See ispackage("package1") + nl + ispackage("package4") + nl + ispackage("package5") + nl + ispackage("package3") + nl 39.9. packages() Function 222
- 246. Ring Documentation, Release1.4.1 Package Package1 Class class1 Func f1 Package Package2 Class class1 Func f1 Package Package3 Class class1 Func f1 Package Package4 Class class1 Func f1 Output: 1 1 0 1 39.11 classes() Function We can get a list of classes names using the classes() function. Syntax: classes() --> a list contains classes names Example: See classes() Class class1 Func f1 Class class2 Func f1 Class class3 Func f1 Output: class1 class2 class3 39.12 isclass() Function We can check if a class is defined or not using the isclass() function. Syntax: 39.11. classes() Function 223
- 247. Ring Documentation, Release1.4.1 isclass(cClassName) --> returns 1 if the Class is defined returns 0 if the Class is not defined Example: see isclass("class4") + nl + isclass("class3") + nl + isclass("class2") + nl Class class1 func f1 class class2 func f1 class class3 func f1 Output: 0 1 1 39.13 packageclasses() Function We can get a list of classes names inside a package using the packageclasses() function. Syntax: packageclasses(cPackageName) --> a list contains classes names inside the package Example: see "classes in Package1" + nl see packageclasses("Package1") see "classes in Package2" + nl see packageclasses("Package2") Package Package1 Class class1 Func f1 Package Package2 Class class1 Func f1 Class class2 Func f1 Class class3 func f1 Output: classes in Package1 class1 classes in Package2 class1 39.13. packageclasses() Function 224
- 248. Ring Documentation, Release1.4.1 class2 class3 39.14 ispackageclass() Function We can check if a class is defined inside package or not using the ispackageclass() function. Syntax: ispackageclass(cPackageName,cClassName) --> returns 1 if the Class is defined returns 0 if the Class is not defined Example: see ispackageclass("package1","class1") + nl + ispackageclass("package1","class2") + nl + ispackageclass("package2","class1") + nl + ispackageclass("package2","class2") + nl Package Package1 Class class1 Func f1 Package Package2 Class class1 Func f1 Class class2 Func f1 Class class3 func f1 Output: 1 0 1 1 39.15 classname() Function We can know the class name of an object using the classname() function Syntax: classname(object) --> Returns the object class name Example: o1 = new point o2 = new rect see classname(o1) + nl # print point see classname(o2) + nl # print rect class point class rect 39.14. ispackageclass() Function 225
- 249. Ring Documentation, Release1.4.1 39.16 objectid() Function We can know the object id using the objectid() function Syntax: objectid(object) --> Returns the object id Example: o1 = new point see objectid(o1) + nl test(o1) func test v see objectid(v) + nl Class point x y z Output: 021B5808 021B5808 39.17 isobject() Function We can check the variable to know if it’s an object or not using the isobject() function Syntax: isobject(variable) --> Returns True if it's an object, False if it's not 39.18 attributes() Function We can get the object attributes using the attributes() function Syntax: attributes(object) --> Returns a list contains the object attributes Example: o1 = new point aList = attributes(o1) # we can use see attributes(o1) for t in aList see t next # print xyz Class Point x y z 39.19 methods() Function We can get the object methods using the methods() function Syntax: 39.16. objectid() Function 226
- 250. Ring Documentation, Release1.4.1 methods(object) --> Returns a list contains the object methods Example: o1 = new test aList = methods(o1) for x in aList cCode = "o1."+x+"()" eval(cCode) next Class Test func f1 see "hello from f1" + nl func f2 see "hello from f2" + nl func f3 see "hello from f3" + nl func f4 see "hello from f4" + nl Output: hello from f1 hello from f2 hello from f3 hello from f4 39.20 isattribute() Function We can test if the object contains an attribute or not using the isattribute() function Syntax: isattribute(object,cAttributeName) --> Returns True if the object contains the attribute Example: o1 = new point see isattribute(o1,"x") + nl # print 1 see isattribute(o1,"t") + nl # print 0 see isattribute(o1,"y") + nl # print 1 see isattribute(o1,"z") + nl # print 1 class point x y z 39.21 isprivateattribute() Function We can test if the object contains a private attribute or not using the isprivateattribute() function Syntax: 39.20. isattribute() Function 227
- 251. Ring Documentation, Release1.4.1 isprivateattribute(object,cAttributeName) --> Returns True if the object contains the private attribute Example: o1 = new person see isprivateattribute(o1,"name") + nl + isprivateattribute(o1,"address") + nl + isprivateattribute(o1,"phone") + nl + isprivateattribute(o1,"job") + nl + isprivateattribute(o1,"salary") Class Person name address phone private job salary Output: 0 0 0 1 1 39.22 ismethod() Function We can test if the object class contains a method or not using the ismethod() function Syntax: ismethod(object,cMethodName) --> Returns True if the object class contains the method Example: o1 = new point see ismethod(o1,"print") + nl # print 1 mylist = [] mylist + new point see ismethod(mylist[1],"print") + nl # print 1 class point x y z func print see x + nl + y + nl + z + nl 39.23 isprivatemethod() Function We can test if the object class contains a private method or not using the isprivatemethod() function Syntax: 39.22. ismethod() Function 228
- 252. Ring Documentation, Release1.4.1 isprivatemethod(object,cMethodName) --> Returns True if the object class contains the private method Example: o1 = new Test see isprivatemethod(o1,"f1") + nl + isprivatemethod(o1,"f2") Class Test func f1 see "message from f1()" + nl private func f2 see "message from f2()" + nl Output: 0 1 39.24 addattribute() Function We can add an attribute (or a group of attributes) to the object state (not the class) using the addattribute() function Syntax: AddAttribute(object,cAttributeName|aAttributesList) Example(1): see new point {x=10 y=20 z=30} Class Point AddAttribute(self,["x","y","z"]) Example(2): o1 = new point addattribute(o1,"x") addattribute(o1,"y") addattribute(o1,"z") see o1 {x=10 y=20 z=30} class point Output: x: 10.000000 y: 20.000000 z: 30.000000 39.25 addmethod() Function We can add a method to the object class using the addmethod() function This method can be used with any object from the same class. 39.24. addattribute() Function 229
- 253. Ring Documentation, Release1.4.1 Syntax: AddMethod(Object,cNewMethodName,cMethodName|AnonymousFunction) Example: o1 = new point { x=10 y=20 z=30 } addmethod(o1,"print", func { see x + nl + y + nl + z + nl } ) o1.print() Class point x y z Output: 10 20 30 Instead of using anonymous function to add new method to the class, we can use the function name Example: o1 = new point { x=10 y=20 z=30 } myfunc = func { see x + nl + y + nl + z + nl } addmethod(o1,"print", myfunc ) addmethod(o1,"display", myfunc ) addmethod(o1,"show", myfunc ) o1.print() o1.display() o1.show() Class point x y z Output: 10 20 30 10 20 30 10 20 30 Since we add the method to the class, any object from that class can use this method Example: o1 = new point { x=10 y=20 z=30 } o2 = new point { x=100 y=200 z=300 } o3 = new point { x=50 y=150 z=250 } addmethod(o1,"print", func { see x + nl + y + nl + z + nl } ) 39.25. addmethod() Function 230
- 254. Ring Documentation, Release1.4.1 o1.print() o2.print() o3.print() Class point x y z Output: 10 20 30 100 200 300 50 150 250 39.26 getattribute() function We can get the object attribute value using the getattribute() function Syntax: GetAttribute(oObject,cAttributeName) ---> Attribute Value Example: o1 = new point see getattribute(o1,"name") + nl + getattribute(o1,"x") + nl + getattribute(o1,"y") + nl + getattribute(o1,"z") + nl Class Point x=10 y=20 z=30 name = "3D-Point" Output: 3D-Point 10 20 30 Example: We can Find a Class List Member using GetAttribute() using a function findclass() The Find uses the member name, rather than the column number myList = [new Company {position=3 name="Mahmoud" symbol="MHD"}, new Company {position=2 name="Bert" symbol="BRT"}, new Company {position=1 name="Ring" symbol="RNG"} ] 39.26. getattribute() function 231
- 255. Ring Documentation, Release1.4.1 see myList see nl +"=====================" + nl + nl for i = 1 to len(myList) see "Pos: "+ i +" | "+ myList[i].position +" | "+ myList[i].name + " | "+ myList[i].symbol +" | "+ nl next See findclass(myList, "MHD", "symbol") +nl ### Specify Member class name ###--------------------------------------- func findclass classList, cValue, classMember See nl + "FindClass: " +" "+ cValue + nl + nl for i = 1 to len(classList) result = getattribute( classList[i], classMember ) See "Result-Attr: " + i +" "+ result +nl if result = cValue j = i ok next return j ###-------------------------------------- class company position name symbol Output: Pos: 1 | 3 | Mahmoud | MHD | Pos: 2 | 2 | Bert | BRT | Pos: 3 | 1 | Ring | RNG | FindClass: MHD Result-Attr: 1 MHD Result-Attr: 2 BRT Result-Attr: 3 RNG 1 39.27 setattribute() function We can set the object attribute value using the setattribute() function Syntax: SetAttribute(oObject,cAttributeName,Value) Example: o1 = new person setattribute(o1,"cName","Mahmoud") 39.27. setattribute() function 232
- 256. Ring Documentation, Release1.4.1 setattribute(o1,"nSalary",1000000) setattribute(o1,"aColors",["white","blue","yellow"]) see o1 see o1.aColors Class Person cName nSalary aColors Output: cname: Mahmoud nsalary: 1000000.000000 acolors: List... white blue yellow 39.28 mergemethods() Function We can share methods between classes without inheritance using the MergeMethods() function This function merge class methods to another class. Syntax: MergeMethods(cClassNameDestination,cClassNameSource) Example: mergemethods("count","share") mergemethods("count2","share") o1 = new count { test() } o1 = new count2 { test() } Class Share func one see "one" + nl func two see "two" + nl func three see "three" + nl Class Display Func printline see copy("*",20) + nl Class Count from Display Func test printline() one() two() three() printline() 39.28. mergemethods() Function 233
- 257. Ring Documentation, Release1.4.1 Class Count2 from Display Func test three() two() one() printline() Output: ******************** one two three ******************** three two one ******************** 39.29 packagename() Function We can know the package name of the latest sucessful import command using the packagename() function Syntax: packagename() --> Returns the package name of the latest sucessful import Example: load "weblib.ring" import System.web see packagename() # system.web 39.29. packagename() Function 234
- 258. CHAPTER FORTY STDLIB FUNCTIONS In thischapter we are going to learn about functions in the stdlib.ring 40.1 puts() function print the value then print new line (nl) Syntax: puts(expr) Example: Load "stdlib.ring" Puts("Hello, World!") 40.2 print() function print string - support n,t and r Also we can use #{variable_name} to insert variables values. Syntax: print(string) Example: Load "stdlib.ring" print("nHello, WorldnnHow are you? tt I'm fine!n") x=10 y=20 print("nx value = #{x} , y value = #{y} n") 40.3 getstring() function Get input from the keyboard - return value as string getstring() ---> string 235
- 259. Ring Documentation, Release1.4.1 40.4 getnumber() function Get input from the keyboard - return value as number getnumber() ---> number 40.5 apppath() function Get the path of the application folder Syntax: AppPath() ---> The path as String Example: Load "stdlib.ring" # Application Path Puts("Test AppPath()") See AppPath() + nl 40.6 justfilepath() function Get the path of the file, remove the file name. Syntax: JustFilePath(cFile) ---> The path as String Example: load "stdlib.ring" see justfilePath("b:ringapplicationsrnoternote.ring") Output: b:ringapplicationsrnote 40.7 justfilename() function Get the file, remove the file path. Syntax: JustFileName(cFile) ---> The file name as String Example: load "stdlib.ring" see justfileName("b:ringapplicationsrnoternote.ring") 40.4. getnumber() function 236
- 260. Ring Documentation, Release1.4.1 Output: rnote.ring 40.8 value() function create a copy from a list or object Syntax: value(List) ---> new list Example: Load "stdlib.ring" aList = 1:10 del(value(aList),1) # delete first item see aList # print numbers from 1 to 10 40.9 times() function Execute a Function nCount times Syntax: Times(nCount,function) Example: Load "stdlib.ring" Puts("Test Times()") Times ( 3 , func { see "Hello, World!" + nl } ) 40.10 map() function Execute a Function on each list item Syntax: Map(alist,function) Example: Load "stdlib.ring" Puts("Test Map()") See Map( 1:10, func x { return x*x } ) 40.8. value() function 237
- 261. Ring Documentation, Release1.4.1 40.11 filter() function Execute a Function on each list item to filter items Syntax: Filter(alist,function) Example: Load "stdlib.ring" Puts("Test Filter()") See Filter( 1:10 , func x { if x <= 5 return true else return false ok } ) 40.12 split() function Convert string words to list items Syntax: Split(cstring,delimiter) ---> List Example: Load "stdlib.ring" Puts("Test Split()") See Split("one two three four five"," ") 40.13 splitmany() function Convert string words to list items. Allow many delimiters. Syntax: SplitMany(cstring,delimiters as string or list) --> List Example: Load "stdlib.ring" Puts("Test SplitMany()") See SplitMany("one,two,three,four and five"," ,") 40.14 newlist() function Create a two dimensional list Syntax: NewList(nRows,nColumns) ---> new list Example: 40.11. filter() function 238
- 262. Ring Documentation, Release1.4.1 Load "stdlib.ring" Puts("Test Newlist()") a1 = 3 a2 = 5 chrArray = newlist(a1,a2) numArray = newlist(a1,a2) chrArray[1][1] = "Hello" numArray[1][1] = 987.2 See chrArray[1][1] + nl See numArray[1][1] + nl 40.15 capitalized() function Return a copy of a string with the first letter capitalized Syntax: Capitalized(string) ---> string Example: Load "stdlib.ring" Puts("Test Capitalized()") See capitalized("welcome to the Ring Programming Language") 40.16 isspecial() function Check whether a character is special or not Syntax: IsSpecial(char) ---> True/False Example: Load "stdlib.ring" Puts("Test Isspecial()") See "Isspecial = " + isSpecial("%") + nl 40.17 isvowel() function Check whether a character is vowel or not Syntax: IsVowel(char) ---> True/False Example: 40.15. capitalized() function 239
- 263. Ring Documentation, Release1.4.1 Load "stdlib.ring" Puts("Test Isvowel()") See "Isvowel = " + isVowel("c") + nl 40.18 linecount() function Return the lines count in a text file. Syntax: LineCount(cFileName) ---> Lines Count as number Example: Load "stdlib.ring" Puts("Test Linecount()") See "the number of lines = " + lineCount("test.ring") 40.19 factorial() function Return the factorial of a number Syntax: Factorial(number) ---> number Example: Load "stdlib.ring" Puts("Test Factorial()") see "6 factorial is : " + Factorial(6) 40.20 fibonacci() function Return the fibonacci number Syntax: Fibonacci(number) ---> number Example: Load "stdlib.ring" Puts("Test Fibonacci()") see "6 Fibonacci is : " + Fibonacci(6) 40.18. linecount() function 240
- 264. Ring Documentation, Release1.4.1 40.21 isprime() function Check whether a number is prime or not Syntax: isprime(number) ---> Number Example: Load "stdlib.ring" Puts("Test Isprime()") if isPrime(16) see "16 is a prime number" else see "16 is not a prime number" ok 40.22 sign() function Returns an integer value indicating the sign of a number. Syntax: Sign(number) ---> number ( -1 = negative , 0 , 1 (positive) ) Example: Load "stdlib.ring" Puts("Test Sign()") see "sign of 12 is = " + sign(12) + nl 40.23 list2file() function Write list items to text file (each item in new line). Syntax: List2File(aList,cFileName) Example: Load "stdlib.ring" # Test List2File Puts("Test List2File()") list2file(1:100,"myfile.txt") 40.24 file2list() function Read text file and convert lines to list items Syntax: 40.21. isprime() function 241
- 265. Ring Documentation, Release1.4.1 File2List(cFileName) ---> List Example: Load "stdlib.ring" # Test File2List Puts("Test File2List()") see len(file2list("myfile.txt")) 40.25 startswith() function Returns true if the given string starts with the specified substring. Leading white spaces are ignored. Syntax: StartsWith(string, substring) ---> True/False Example: Load "stdlib.ring" Puts("Test Startswith()") see Startswith("CalmoSoft", "Calmo") + nl 40.26 endswith() function Returns true if the given string ends with the specified substring. Trailing white spaces are ignored. Syntax: Endswith(string, substring) ---> True/False Example: Load "stdlib.ring" Puts("Test Endswith()") see endsWith("CalmoSoft", "Soft") + nl 40.27 gcd() function Finding of the greatest common divisor of two integers. Syntax: Gcd(number,number) ---> number Example: 40.25. startswith() function 242
- 266. Ring Documentation, Release1.4.1 Load "stdlib.ring" Puts("Test Gcd()") see gcd (24, 32) + nl 40.28 lcm() function Compute the least common multiple of two integers. Syntax: lcm(number,number) ---> number Example: Load "stdlib.ring" Puts("Test Lcm()") see Lcm(24,36) + nl 40.29 sumlist() function Compute the sum of a list of integers. Syntax: sumlist(list) ---> number Example: Load "stdlib.ring" Puts("Test Sumlist()") aList = [1,2,3,4,5] see Sumlist(aList) + nl 40.30 prodlist() function Compute the product of a list of integers. Syntax: prodlist(list) ---> number Example: Load "stdlib.ring" Puts("Test Prodlist()") aList = [1,2,3,4,5] see Prodlist(aList) + nl 40.28. lcm() function 243
- 267. Ring Documentation, Release1.4.1 40.31 evenorodd() function Test whether an integer is even or odd. Result of test (1=odd 2=even). Syntax: evenorodd(number) ---> 1 (odd) or 2 (even) Example: Load "stdlib.ring" Puts("Test Evenorodd()") nr = 17 see Evenorodd(nr) + nl 40.32 factors() function Compute the factors of a positive integer. Syntax: factors(list) ---> list Example: Load "stdlib.ring" Puts("Test Factors()") n = 45 aList = factors(n) see "Factors of " + n + " = " for i = 1 to len(aList) see "" + aList[i] + " " next 40.33 palindrome() function Check if a sequence of characters is a palindrome or not. Syntax: Palindrome(String) ---> True/False Example: Load "stdlib.ring" Puts("Test Palindrome()") cString = "radar" see Palindrome(cString) 40.31. evenorodd() function 244
- 268. Ring Documentation, Release1.4.1 40.34 isleapyear() function Check whether a given year is a leap year in the Gregorian calendar. Syntax: Isleapyear(number) ---> True/False Example: Load "stdlib.ring" Puts("Test Isleapyear()") year = 2016 if Isleapyear(year) see "" + year + " is a leap year." else see "" + year + " is not a leap year." ok 40.35 binarydigits() function Compute the sequence of binary digits for a given non-negative integer. Syntax: binarydigits(number) ---> string Example: Load "stdlib.ring" Puts("Test Binarydigits()") b = 35 see "Binary digits of " + b + " = " + Binarydigits(b) 40.36 matrixmulti() function Multiply two matrices together. Syntax: Matrixmulti(List,List) ---> List Example: Load "stdlib.ring" # Multiply two matrices together. Puts("Test Matrixmulti()") A = [[1,2,3], [4,5,6], [7,8,9]] B = [[1,0,0], [0,1,0], [0,0,1]] see Matrixmulti(A, B) 40.37 matrixtrans() function Transpose an arbitrarily sized rectangular Matrix. 40.34. isleapyear() function 245
- 269. Ring Documentation, Release1.4.1 Syntax: Matrixtrans(List) ---> List Example: Load "stdlib.ring" # Transpose an arbitrarily sized rectangular Matrix. Puts("Test Matrixtrans()") matrix = [[78,19,30,12,36], [49,10,65,42,50], [30,93,24,78,10], [39,68,27,64,29]] see Matrixtrans(matrix) 40.38 dayofweek() function Return the day of the week of given date. (yyyy-mm-dd) Syntax: dayofweek(string) ---> string Example: Load "stdlib.ring" # Return the day of the week of given date. Puts("Test Dayofweek()") date = "2016-04-24" see "Data : " + date + " - Day : " + Dayofweek(date) + nl 40.39 permutation() function Generates all permutations of n different numerals. Syntax: permutation(list) Example: Load "stdlib.ring" # Generates all permutations of n different numerals Puts("Test Permutation()") list = [1, 2, 3, 4] for perm = 1 to 24 for i = 1 to len(list) see list[i] + " " next see nl Permutation(list) next 40.38. dayofweek() function 246
- 270. Ring Documentation, Release1.4.1 40.40 readline() function Read line from file Syntax: readline(fp) ---> string Example: Load "stdlib.ring" # Read a file line by line. Puts("Test Readline()") fp = fopen("test.ring","r") while not feof(fp) See Readline(fp) end fclose(fp) 40.41 substring() function Return a position of a substring starting from a given position in a string. Syntax: Substring(str,substr,npos) ---> string Example: Load "stdlib.ring" # Return a position of a substring starting from a given position in a string. Puts("Test Substring()") a = "abcxyzqweabc" b = "abc" i = 4 see substring(a,b,i) 40.42 changestring() function Change substring from given position to a given position with another substring. Syntax: Changestring(cString, nPos1, nPos2, cSubstr) ---> cString Example: Load "stdlib.ring" # Change substring from given position for given position with a substring. Puts("Test Changestring()") see Changestring("Rmasdg",2,5,"in") # Ring 40.40. readline() function 247
- 271. Ring Documentation, Release1.4.1 40.43 sleep() function Sleep for the given amount of time. Syntax: sleep(nSeconds) Example: Load "stdlib.ring" Puts("Test Sleep()") see "Wait 3 Seconds!" Sleep(3) see nl 40.44 ismainsourcefile() function Check if the current file is the main source file Syntax: IsMainSourceFile() ---> True/False Example: Load "stdlib.ring" if ismainsourcefile() # code ok 40.45 direxists() function Check if directory exists Syntax: DirExists(String) ---> True/False Example: Load "stdlib.ring" see "Check dir : b:ring " puts( DirExists("b:ring") ) see "Check dir : C:ring " Puts( DirExists("C:ring") ) 40.46 makedir() function Make Directory 40.43. sleep() function 248
- 272. Ring Documentation, Release1.4.1 Syntax: MakeDir(String) Example: Load "stdlib.ring" # Create Directory puts("create Directory : myfolder") makedir("myfolder") 40.47 fsize() function The function return the file size in bytes. Syntax: FSize(File Handle) ---> Number (File Size in Bytes) 40.48 trimall() function Remove all spaces and tabs characters from a string Syntax: TrimAll(cString) ---> cString # Without Spaces and Tabs 40.49 trimleft() function Remove all spaces and tabs characters from the left side of a string Syntax: TrimLeft(cString) ---> cString # Without Spaces and Tabs from the left side 40.50 trimright() function Remove all spaces and tabs characters from the right side of a string Syntax: TrimRight(cString) ---> cString # Without Spaces and Tabs from the right side 40.51 epochtime() function Return the Epoch Time Syntax: 40.47. fsize() function 249
- 273. Ring Documentation, Release1.4.1 EpochTime(cDate,cTime) ---> nEpochTime Example: see EpochTime( Date(), Time() ) 40.51. epochtime() function 250
- 274. CHAPTER FORTYONE STDLIB CLASSES In thischapter we are going to learn about the classes in the stdlib.ring • StdBase Class • String Class • List Class • Stack Class • Queue Class • HashTable Class • Tree Class • Math Class • DateTime Class • File Class • System Class • Debug Class • DataType Class • Conversion Class • ODBC CLass • MySQL Class • SQLite Class • Security Class • Internet Class 41.1 StdBase Class Attributes: • vValue : Object Value Methods: 251
- 275. Ring Documentation, Release1.4.1 Method Description/Output Init(x) Set vValue Attribute to x value Print() Print vValue PrintLn() Print vValue then New Line Size() return number represent the size of vValue Value() return vValue Set(x) Call Init(x) 41.2 String Class Parent Class : StdBase Class Methods: Method Description/Output Init(String|Number|List) Lower() New String - Lower case characters Upper() New String - Upper case characters Left(x) New String - contains x characters from the left Right(x) New String - contains x characters from the right Lines() Number - Lines count Trim() New String - Remove Spaces Copy(x) New String - repeat string x times strcmp(cString) Compare string with cString tolist() List (String Lines to String Items) tofile(cFileName) Write string to file mid(nPos1,nPos2) New String - from nPos1 to nPos2 getfrom(nPos1) New String - from nPos1 to the end of the string replace(cStr1,cStr2,lCase) New String - Replace cStr1 with cStr2 , lCase (True=Math Case) split() List - Each Word as list item startswith(substring) Return true if the start starts with a substring endswith(substring) Return true if the start ends with a substring Example: Load "stdlib.ring" See "Testing the String Class" + nl oString = new string("Hello, World!") oString.println() oString.upper().println() oString.lower().println() oString.left(5).println() oString.right(6).println() oString = new string("Hi" + nl + "Hello" ) See oString.lines() + nl oString = new string(" Welcome ") oString.println() oString.trim().println() oString = new string("Hello! ") oString.copy(3).println() see oString.strcmp("Hello! ") + nl see oString.strcmp("Hello ") + nl see oString.strcmp("Hello!! ") + nl oString = new string(["one","two","three"]) 41.2. String Class 252
- 276. Ring Documentation, Release1.4.1 oString.print() see oString.lines() + nl oString = new String(1234) oString.println() oString = new String("one"+nl+"two"+nl+"three") aList = oString.tolist() see "List Items" + nl See aList oString = new String( "Welcome to the Ring programming language") See "the - position : " + oString.pos("the") + nl oString = oString.getfrom(oString.pos("Ring")) oString.println() oString.mid(1,4).println() oString = oString.replace("Ring","***Ring***",true) oString.println() oString = oString.replace("ring","***Ring***",false) oString.println() oString1 = new string("First") oString2 = new string("Second") oString = oString1 + oString2 oString.println() oString = oString1 * 3 oString.println() for t in ostring see t next oString.tofile("test.txt") oString = new string("one two three") see nl see ostring.split() oString { set("Hello") println() set("How are you?") println() } Output: Testing the String Class Hello, World! HELLO, WORLD! hello, world! Hello World! 2 Welcome Welcome Hello! Hello! Hello! 0 1 -1 one two three 4 1234 List Items one two three the - position : 12 Ring programming language 41.2. String Class 253
- 277. Ring Documentation, Release1.4.1 Ring ***Ring*** programming language ******Ring****** programming language FirstSecond FirstFirstFirst FirstFirstFirst one two three Hello How are you? 41.3 List Class Parent Class : StdBase Class Methods: Method Description/Output Init(String|List) Add(Value) Add item to the list Delete(nIndex) Delete item from the list Item(nIndex) Get item from the list First() Get the first item in the list Last() Get the last item in the list Set(nIndex,Value) Set item value FindInColumn(nCol,Value) Find item in a column Sort() Sort items - return new list Reverse() Reverse items - return new list Insert(nIndex,Value) Inset Item after nIndex example: Load "stdlib.ring" oList = new list ( [1,2,3] ) oList.Add(4) oList.print() see oList.item(1) + nl oList.delete(4) oList.print() see oList.first() + nl see oList.last() + nl oList { set(1,"one") set(2,"two") set(3,"three") print() } see oList.find("two") + nl oList.sort().print() oList.reverse().print() oList.insert(2,"nice") oList.print() oList = new list ( [ [1,"one"],[2,"two"],[3,"three"] ] ) see copy("*",10) + nl oList.print() see "Search two : " + oList.findincolumn(2,"two") + nl see "Search 1 : " + oList.findincolumn(1,1) + nl oList = new list ( [ "Egypt" , "USA" , "KSA" ] ) for x in oList 41.3. List Class 254
- 278. Ring Documentation, Release1.4.1 see x + nl next oList = new list ( [1,2,3,4] ) oList + [5,6,7] oList.print() oList = new list ( ["one","two"] ) oList2 = new list ( ["three","four"] ) oList + oList2 oList.print() output: 1 2 3 4 1 1 2 3 1 3 one two three 2 one three two three two one one two nice three ********** 1 one 2 two 3 three Search two : 2 Search 1 : 1 Egypt USA KSA 1 2 3 4 5 6 7 one two three 41.3. List Class 255
- 279. Ring Documentation, Release1.4.1 four 41.4 Stack Class Parent Class : List Class Methods: Method Description/Output Init(String|Number|List) Push(Value) Push item to the stack Pop() Pop item from the stack Print() Print the stack items example: Load "stdlib.ring" oStack = new Stack oStack.push(1) oStack.push(2) oStack.push(3) see oStack.pop() + nl see oStack.pop() + nl see oStack.pop() + nl oStack.push(4) see oStack.pop() + nl oStack { push("one") push("two") push("three") } oStack.print() output: 3 2 1 4 three two one 41.5 Queue Class Parent Class : List Class Methods: Method Description/Output Init(String|Number|List) Remove() Remove item from the Queue. example: Load "stdlib.ring" oQueue = new Queue oQueue.add(1) 41.4. Stack Class 256
- 280. Ring Documentation, Release1.4.1 oQueue.add(2) oQueue.add(3) see oQueue.remove() + nl see oQueue.remove() + nl see oQueue.remove() + nl oQueue.add(4) see oQueue.remove() + nl oQueue { add("one") add("two") add("three") } oQueue.print() output: 1 2 3 4 one two three 41.6 HashTable Class Parent Class : List Class Methods: Method Description/Output Init(List) Add(cKey,Value) Add item to the HashTable Set(cKey,Value) Set item value using the Key GetValue(cKey) Get item value using the Key Contains(cKey) Check if the HashTable contains item using the Key Index(cKey) Get the item index using the Key example: Load "stdlib.ring" ohashtable = new hashtable See "Test the hashtable Class Methods" + nl ohashtable { Add("Egypt","Cairo") Add("KSA","Riyadh") see self["Egypt"] + nl see self["KSA"] + nl see contains("Egypt") + nl see contains("USA") + nl see index("KSA") + NL print() delete(index("KSA")) see copy("*",60) + nl print() } output: 41.6. HashTable Class 257
- 281. Ring Documentation, Release1.4.1 Test the hashtable Class Methods Cairo Riyadh 1 0 2 Egypt Cairo KSA Riyadh ************************************************************ Egypt Cairo 41.7 Tree Class Data: Attribute Description Data Node Value Children Children List Methods: Method Description/Output set(value) Set the node value. value() Get the node value. Add(value) Add new child. parent() Get the parent node. print() Print the tree nodes. example: Load "stdlib.ring" otree = new tree See "Test the tree Class Methods" + nl otree { set("The first step") # set the root node value see value() + nl Add("one") Add("two") Add("three") { Add("3.1") Add("3.2") Add("3.3") see children } see children oTree.children[2] { Add("2.1") Add("2.2") Add("2.3") { Add("2.3.1") Add("2.3.2") Add("test") } } oTree.children[2].children[3].children[3].set("2.3.3") } 41.7. Tree Class 258
- 282. Ring Documentation, Release1.4.1 see copy("*",60) + nl oTree.print() output: Test the tree Class Methods The first step data: 3.1 parent: List... children: List... data: 3.2 parent: List... children: List... data: 3.3 parent: List... children: List... data: one parent: List... children: List... data: two parent: List... children: List... data: three parent: List... children: List... ************************************************************ one two 2.1 2.2 2.3 2.3.1 2.3.2 2.3.3 three 3.1 3.2 3.3 41.8 Math Class Methods: 41.8. Math Class 259
- 283. Ring Documentation, Release1.4.1 Method Description sin(x) Returns the sine of an angle of x radians cos(x) Returns the cosine of an angle of x radians tan(x) Returns the tangent of an angle of x radians asin(x) Returns the principal value of the arc sine of x, expressed in radians acos(x) Returns the principal value of the arc cosine of x, expressed in radians atan(x) Returns the principal value of the arc tangent of x, expressed in radians atan2(y,x) Returns the principal arc tangent of y/x, in the interval [-pi,+pi] radians sinh(x) Returns the hyperbolic sine of x radians cosh(x) Returns the hyperbolic cosine of x radians tanh(x) Returns the hyperbolic tangent of x radians exp(x) Returns the value of e raised to the xth power log(x) Returns the natural logarithm of x log10(x) Returns the common logarithm (base-10 logarithm) of x ceil(x) Returns the smallest integer value greater than or equal to x floor(x) Returns the largest integer value less than or equal to x fabs(x) Returns the absolute value of x. pow(x,y) Returns x raised to the power of y sqrt(x) Returns the square root of x random(x) Returns a random number in the range [0,x] unsigned(n,n,c) Perform operation using unsigned numbers decimals(n) Determine the decimals digits after the point in float/double numbers example: Load "stdlib.ring" oMath = new Math See "Test the Math Class Methods" + nl See "Sin(0) = " + oMath.sin(0) + nl See "Sin(90) radians = " + oMath.sin(90) + nl See "Sin(90) degree = " + oMath.sin(90*3.14/180) + nl See "Cos(0) = " + oMath.cos(0) + nl See "Cos(90) radians = " + oMath.cos(90) + nl See "Cos(90) degree = " +oMath. cos(90*3.14/180) + nl See "Tan(0) = " + oMath.tan(0) + nl See "Tan(90) radians = " + oMath.tan(90) + nl See "Tan(90) degree = " + oMath.tan(90*3.14/180) + nl See "asin(0) = " + oMath.asin(0) + nl See "acos(0) = " + oMath.acos(0) + nl See "atan(0) = " + oMath.atan(0) + nl See "atan2(1,1) = " +oMath. atan2(1,1) + nl See "sinh(0) = " + oMath.sinh(0) + nl See "sinh(1) = " + oMath.sinh(1) + nl See "cosh(0) = " + oMath.cosh(0) + nl See "cosh(1) = " + oMath.cosh(1) + nl See "tanh(0) = " + oMath.tanh(0) + nl See "tanh(1) = " + oMath.tanh(1) + nl See "exp(0) = " + oMath.exp(0) + nl See "exp(1) = " + oMath.exp(1) + nl See "log(1) = " + oMath.log(1) + nl 41.8. Math Class 260
- 284. Ring Documentation, Release1.4.1 See "log(2) = " + oMath.log(2) + nl See "log10(1) = " + oMath.log10(1) + nl See "log10(2) = " + oMath.log10(2) + nl See "log10(10) = " + oMath.log10(10) + nl See "Ceil(1.12) = " + oMath.Ceil(1.12) + nl See "Ceil(1.72) = " + oMath.Ceil(1.72) + nl See "Floor(1.12) = " + oMath.floor(1.12) + nl See "Floor(1.72) = " + oMath.floor(1.72) + nl See "fabs(1.12) = " + oMath.fabs(1.12) + nl See "fabs(1.72) = " + oMath.fabs(1.72) + nl See "pow(2,3) = " + oMath.pow(2,3) + nl see "sqrt(16) = " + oMath.sqrt(16) + nl for x = 1 to 20 see "Random number Max (100) : " + oMath.random(100) + nl next x = 1.1234567890123 for d = 0 to 14 oMath.decimals(d) see x + nl next cKey = "hello" h = 0 for x in cKey h = oMath.unsigned(h,ascii(x),"+") h = oMath.unsigned(h,oMath.unsigned(h,10,"<<"),"+") r = oMath.unsigned(h,6,">>") h = oMath.unsigned(h, r,"^") next h = oMath.unsigned(h,oMath.unsigned(h,3,"<<"),"+") h = oMath.unsigned(h,oMath.unsigned(h,11,">>"),"^") h = oMath.unsigned(h,oMath.unsigned(h,15,"<<"),"+") see "Hash : " + h output: Test the Math Class Methods Sin(0) = 0 Sin(90) radians = 0.89 Sin(90) degree = 1.00 Cos(0) = 1 Cos(90) radians = -0.45 Cos(90) degree = 0.00 Tan(0) = 0 Tan(90) radians = -2.00 Tan(90) degree = 1255.77 asin(0) = 0 acos(0) = 1.57 atan(0) = 0 atan2(1,1) = 0.79 41.8. Math Class 261
- 285. Ring Documentation, Release1.4.1 sinh(0) = 0 sinh(1) = 1.18 cosh(0) = 1 cosh(1) = 1.54 tanh(0) = 0 tanh(1) = 0.76 exp(0) = 1 exp(1) = 2.72 log(1) = 0 log(2) = 0.69 log10(1) = 0 log10(2) = 0.30 log10(10) = 1 Ceil(1.12) = 2 Ceil(1.72) = 2 Floor(1.12) = 1 Floor(1.72) = 1 fabs(1.12) = 1.12 fabs(1.72) = 1.72 pow(2,3) = 8 sqrt(16) = 4 Random number Max (100) : 87 Random number Max (100) : 49 Random number Max (100) : 99 Random number Max (100) : 58 Random number Max (100) : 15 Random number Max (100) : 46 Random number Max (100) : 37 Random number Max (100) : 64 Random number Max (100) : 73 Random number Max (100) : 35 Random number Max (100) : 89 Random number Max (100) : 80 Random number Max (100) : 20 Random number Max (100) : 33 Random number Max (100) : 44 Random number Max (100) : 89 Random number Max (100) : 82 Random number Max (100) : 94 Random number Max (100) : 83 Random number Max (100) : 68 1 1.1 1.12 1.123 1.1235 1.12346 1.123457 1.1234568 1.12345679 1.123456789 1.1234567890 1.12345678901 1.123456789012 1.1234567890123 1.12345678901230 Hash : 3372029979.00000000000000 41.8. Math Class 262
- 286. Ring Documentation, Release1.4.1 41.9 DateTime Class Methods: Method Description/Output clock() The number of clock ticks from program start. time() Get the system time. date() Get the date. timelist() List contains the date and the time information. adddays(cDate,nDays) Return Date from cDate and after nDays diffdays(cDate1,cDate2) Return the Number of days (cDate1 - cDate2) example: Load "stdlib.ring" oDateTime = new datetime See "Test the datetime Class Methods" + nl See "Calculate performance" + nl t1 = oDateTime.clock() for x = 1 to 1000000 next see oDateTime.clock() - t1 + nl See "Time : " + oDateTime.time() + nl See "Date : " + oDateTime.date() + nl See oDateTime.TimeList() See "Month Name : " + oDateTime.TimeList()[4] cDate = oDateTime.date() see cDate + nl cDate = oDateTime.adddays(cDate,10) see cDate + nl cDate1 = oDateTime.date() see cDate1 + nl cDate2 = oDateTime.adddays(cDate1,10) see cDate2 + nl see "DiffDays = " + oDateTime.diffdays(cDate1,cDate2) + nl see "DiffDays = " + oDateTime.diffdays(cDate2,cDate1) + nl output: Test the datetime Class Methods Calculate performance 85 Time : 02:53:35 Date : 31/08/2016 Wed Wednesday Aug August 08/31/16 02:53:35 31 41.9. DateTime Class 263
- 287. Ring Documentation, Release1.4.1 02 02 244 08 53 AM 35 35 3 08/31/16 02:53:35 16 2016 Arab Standard Time % Month Name : August31/08/2016 10/09/2016 31/08/2016 10/09/2016 DiffDays = -10 DiffDays = 10 41.10 File Class Methods: 41.10. File Class 264
- 288. Ring Documentation, Release1.4.1 Method Description/Output read(cFileName) Read the file content write(cFileName,cStr) Write string to file dir(cFolderPath) Get the folder contents (files & sub folders) rename(cOld,cNew) Rename files using the Rename() function remove(cFileName) Delete a file using the Remove() function open(cFileName,cMode) Open a file using the Fopen() function close() Close file flush() Flushes the output buffer of a stream reopen(cFileName,cMode) Open another file using the same file handle tempfile() Creates a temp. file (binary). seek(noffset,nwhence) Set the file position of the stream tell() Know the current file position of a stream rewind() Set the file position to the beginning of the file getpos() Get handle to the current file position setpos(poshandle) Set the current file position clearerr() Clear the EOF error and the error indicators of a stream eof() Test the end-of-file indicator error() Test the error indicator perror(cErrorMessage) Print error message to the stderr getc() Get the next character from the stream gets(nsize) Read new line from the stream putc(cchar) Write a character to the stream puts(cStr) Write a string to the stream ungetc(cchar) Push a character to the stream fread(nsize) Read data from a stream fwrite(cString) Write data to a stream exists(cFileName) Check if a file exists example: Load "stdlib.ring" ofile = new file See "Test the file Class Methods" + nl see ofile.read(filename()) see nl ofile.open(filename(),"r") see ofile.gets(100) + nl ofile.close() 41.11 System Class Methods: 41.11. System Class 265
- 289. Ring Documentation, Release1.4.1 Method Description/Output system() Execute system commands sysget() Get environment variables ismsdos() Check if the operating system is MSDOS or not iswindows() Check if the operating system is Windows or not iswindows64() Check if the operating system is Windows 64bit or not isunix() Check if the operating system is Unix or not ismacosx() Check if the operating system is Mac OS X or not islinux() Check if the operating system is Linux or not isfreebsd() Check if the operating system is FreeBSD or not isandroid() Check if the operating system is Android or not windowsnl() Get the windows new line string sysargv() Get the command line arguments passed to the ring script filename() Get the active source file example: Load "stdlib.ring" oSystem = new System See "Test the System Class Methods" + nl oSystem.system("dir") see oSystem.sysget("path") + nl see oSystem.ismsdos() + nl see oSystem.iswindows() + nl see oSystem.iswindows64() + nl see oSystem.isunix() + nl see oSystem.ismacosx() + nl see oSystem.islinux() + nl see oSystem.isfreebsd() + nl see oSystem.isandroid() + nl see oSystem.windowsnl() + nl see oSystem.sysargv() + nl see oSystem.filename() + nl 41.12 Debug Class Methods: Method Description/Output eval(cCode) Execute code during the runtime from string. raise(cError) Raise an exception. assert(cCondition) Test condition before executing the code. example: Load "stdlib.ring" oDebug = new Debug See "Test the Debug Class Methods" + nl oDebug.eval("see 'Hello'+nl") try x = 10 oDebug.assert(x=11) 41.12. Debug Class 266
- 290. Ring Documentation, Release1.4.1 catch see "assert" + nl done raise("Error!") 41.13 DataType Class Methods: Method Description/Output isstring(vValue) We can know if the value is a string or not. isnumber(vValue) We can know if the value is a number or not. islist(vValue) We can know if the value is a list or not. type(vValue) Know the type of a value isnull(vValue) Check the value to know if it’s null or not. isalnum(vValue) 1 if the value is digit/letter or 0 if not isalpha(vValue) 1 if the value is a letter or 0 if not iscntrl(vValue) 1 if the value is a control character (no printing position) isdigit(vValue) 1 if the value is a digit or 0 if not isgraph(vValue) 1 if the value can be printed (Except space) or 0 if not islower(vValue) 1 if the value is lowercase letter or 0 if not isprint(vValue) 1 if the value occupies a printing position or 0 if not ispunct(vValue) 1 if the value is a punctuation character or 0 if not isspace(vValue) 1 if the value is a white-space or 0 if not isupper(vValue) 1 if the value is an uppercase alphabetic letter or 0 if not isxdigit(vValue) 1 if the value is a hexdecimal digit character or 0 if not example: Load "stdlib.ring" oDataType = new DataType See "Test the DataType Class Methods" + nl see oDataType.isstring("test") + nl see oDataType.isnumber(1) + nl see oDataType.islist(1:3) + nl see oDataType.type("test") + nl see oDataType.isnull(null) + nl see oDataType.isalnum("Hello") + nl + # print 1 oDataType.isalnum("123456") + nl + # print 1 oDataType.isalnum("ABCabc123") + nl + # print 1 oDataType.isalnum("How are you") + nl # print 0 because of spaces see oDataType.isalpha("Hello") + nl + # print 1 oDataType.isalpha("123456") + nl + # print 0 oDataType.isalpha("ABCabc123") + nl + # print 0 oDataType.isalpha("How are you") + nl # print 0 See oDataType.iscntrl("hello") + nl + # print 0 oDataType.iscntrl(nl) # print 1 see oDataType.isdigit("0123456789") + nl + # print 1 oDataType.isdigit("0123a") + nl see oDataType.isgraph("abcdef") + nl + # print 1 oDataType.isgraph("abc def") + nl # print 0 see oDataType.islower("abcDEF") + nl + # print 0 oDataType.islower("ghi") + nl # print 1 see oDataType.isprint("Hello") + nl + # print 1 oDataType.isprint("Nice to see you") + nl + # print 1 oDataType.isprint(nl) + nl # print 0 41.13. DataType Class 267
- 291. Ring Documentation, Release1.4.1 see oDataType.isprint("Hello") + nl # print 1 see oDataType.isupper("welcome") + nl + # print 0 oDataType.isupper("WELCOME") + nl # print 1 see oDataType.isxdigit("0123456789abcdef") + nl + # print 1 oDataType.isxdigit("123z") # print 0 Output: Test the DataType Class Methods 1 1 1 STRING 1 1 1 1 0 1 0 0 0 0 11 0 1 0 0 1 1 1 0 1 0 1 1 0 41.14 Conversion Class Methods: Method Description/Output number(vValue) Convert strings to numbers. string(vValue) Convert numbers to strings. ascii(vValue) Get the ASCII code for a letter. char(vValue) Convert the ASCII code to character. hex(vValue) Convert decimal to hexadecimal. dec(vValue) Convert hexadecimal to decimal. str2hex(vValue) Convert string characters to hexadecimal characters. hex2str(vValue) Convert hexadecimal characters to string. example: Load "stdlib.ring" 41.14. Conversion Class 268
- 292. Ring Documentation, Release1.4.1 oConversion = new conversion See "Test the conversion Class Methods" + nl See oConversion.number("3") + 5 + nl See oConversion.string(3) + "5" + nl See oConversion.Ascii("m") + nl See oConversion.char(77) + nl see oConversion.hex(162) + nl see oConversion.dec("a2") + nl cHex = oConversion.str2hex("Hello") see cHex + nl see oConversion.hex2str(cHex) + nl Output: Test the conversion Class Methods 8 35 109 M a2 162 48656c6c6f Hello 41.15 ODBC Class Methods: Method Description/Output drivers() Get a list of ODBC drivers. datasources() Get a list of ODBC data sources. close() Free resources. connect(cConString) Connect to the database. disconnect() Close the connection. execute(cSQL) Execute SQL Statements colcount() Get columns count in the query result fetch() Fetch a row from the query result getdata(nCol) Get column value from the fetched row tables() Get a list of tables inside the database columns(cTableName) Get a list of columns inside the table autocommit(lStatus) Enable or disable the auto commit feature commit() Commit updates to the database rollback() Rollback updates to the database example: Load "stdlib.ring" oodbc = new odbc See "Test the odbc Class Methods" + nl oODBC { see drivers() see datasources() See "Connect to database" + nl see connect("DBQ=test.mdb;Driver={Microsoft Access Driver (*.mdb)}") + nl See "Select data" + nl 41.15. ODBC Class 269
- 293. Ring Documentation, Release1.4.1 see execute("select * from person") + nl nMax = colcount() See "Columns Count : " + nMax + nl while fetch() See "Row data:" + nl for x = 1 to nMax see getdata(x) + " - " next end See "Close database..." + nl disconnect() close() } 41.16 MySQL Class Methods: Method Description/Output info() Return string contains the MySQL Client version. error() Get the error message from the MySQL Client. connect(cServer,cUser,cPass,cDatabase) Connect to the MySQL database server. close() Close the connection to the MySQL database. query(cQuery) Execute SQL queries. insert_id() Get the inserted row id. result() Get the query result (data without column names). next_result() Move to the next query result. columns() Get a list of columns names. result2() Get all of the column names then the query result in one list. escape_string(cStr) Before storing binary data and special characters in the database. autocommit(lStatus) Enable or disable the auto commit feature. commit() Commit updates to the database. rollback() Rollback updates to the database. example: Load "stdlib.ring" omysql = new mysql See "Test the MySQL Class Methods" + nl omysql { see info() + nl connect("localhost", "root", "root","mahdb") see "Execute Query" + nl query("SELECT * FROM Employee") see "Print Result" + nl see result2() see "Close database" + nl close() } Output: Test the MySQL Class Methods 5.5.30 41.16. MySQL Class 270
- 294. Ring Documentation, Release1.4.1 Execute Query Print Result Id Name Salary 1 Mahmoud 15000 2 Samir 16000 3 Fayed 17000 Close database 41.17 SQLite Class Methods: Method Description/Output open(cDatabase) Open Database. close() Close Database. errormessage() Get Error Message. execute(cSQL) Execute Query. example: Load "stdlib.ring" osqlite = new sqlite See "Test the sqlite Class Methods" + nl osqlite { open("test.db") sql = "CREATE TABLE COMPANY(" + "ID INT PRIMARY KEY NOT NULL," + "NAME TEXT NOT NULL," + "AGE INT NOT NULL," + "ADDRESS CHAR(50)," + "SALARY REAL );" execute(sql) sql = "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (1, 'Mahmoud', 29, 'Jeddah', 20000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY) " + "VALUES (2, 'Ahmed', 27, 'Jeddah', 15000.00 ); " + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (3, 'Mohammed', 31, 'Egypt', 20000.00 );" + "INSERT INTO COMPANY (ID,NAME,AGE,ADDRESS,SALARY)" + "VALUES (4, 'Ibrahim', 24, 'Egypt ', 65000.00 );" execute(sql) aResult = execute("select * from COMPANY") for x in aResult for t in x 41.17. SQLite Class 271
- 295. Ring Documentation, Release1.4.1 see t[2] + nl next next see copy("*",50) + nl for x in aResult see x["name"] + nl next close() } Output: Test the sqlite Class Methods 1 Mahmoud 29 Jeddah 20000.0 2 Ahmed 27 Jeddah 15000.0 3 Mohammed 31 Egypt 20000.0 4 Ibrahim 24 Egypt 65000.0 ************************************************** Mahmoud Ahmed Mohammed Ibrahim 41.18 Security Class Methods: Method Description/Output md5(cString) Calculate the MD5 hash. sha1(cString) Calculate the SHA1 hash. sha256(cString) Calculate the SHA256 hash. sha512(cString) Calculate the SHA512 hash. sha384(cString) Calculate the SHA384 hash. sha224(cString) Calculate the SHA224 hash. encrypt(cString,cKey,cIV) Cncrypts the data using the Blowfish algorithm. decrypt(cString,cKey,cIV) Decrypt the data encrypted using the Encrypt() method. randbytes(nSize) Generate a string of pseudo-random bytes. example: 41.18. Security Class 272
- 296. Ring Documentation, Release1.4.1 Load "stdlib.ring" osecuirty = new secuirty See "Test the secuirty Class Methods" + nl oSecuirty { see md5("hello") + nl + sha1("hello") + nl + sha256("hello") + nl + sha512("hello") + nl + sha384("hello") + nl + sha256("hello") + nl list = 0:15 cKey="" for x in list cKey += char(x) next list = 1:8 cIV = "" for x in list cIV += char(x) next cCipher = encrypt("hello",cKey,cIV) see cCipher + nl + decrypt(cCipher,cKey,cIV) + nl } 41.19 Internet Class Methods: • download(cURL) • sendemail(cSMTPServer,cEmail,cPassword,cSender,cReceiver,cCC,cTitle,cContent) example: Load "stdlib.ring" ointernet = new internet See "Test the internet Class Methods" + nl ointernet { see download("www.ring-lang.sf.net") } 41.19. Internet Class 273
- 297. CHAPTER FORTYTWO DECLARATIVE PROGRAMMING USINGNESTED STRUCTURES In this chapter we are going to learn how to build declarative programming world using nested structures on the top of object oriented. We will learn about • Creating Objects inside Lists • Composition and Returning Objects and Lists by Reference • Executing code after the end of object access • Declarative Programming on the top of Object-Oriented 42.1 Creating Objects inside Lists We can create objects inside lists during list definition. Also we can add objects to the list at any time using the Add() function or the + operator. Example: alist = [new point, new point, new point] # create list contains three objects alist + [1,2,3] # add another item to the list see "Item 4 is a list contains 3 items" + nl see alist[4] add(alist , new point) alist + new point alist[5] { x = 100 y = 200 z = 300 } alist[6] { x = 50 y = 150 z = 250 } see "Object inside item 5" + nl see alist[5] see "Object inside item 6" + nl see alist[6] class point x y z Output: Item 4 is a list contains 3 items 1 2 274
- 298. Ring Documentation, Release1.4.1 3 Object inside item 5 x: 100.000000 y: 200.000000 z: 300.000000 Object inside item 6 x: 50.000000 y: 150.000000 z: 250.000000 42.2 Composition and Returning Objects and Lists by Reference When we use composition and have object as one of the class attributes, when we return that object it will be returned by reference. if the called used the assignment operator, another copy of the object will be created. The caller can avoid using the assignment operator and use the returned reference directly to access the object. The same is done also if the attribute is a list (not object). Note: Objects and Lists are treated using the same rules. When you pass them to function they are passed by reference, when you return them from functions they are returned by value except if it’s an object attribute where a return by reference will be done. Example: o1 = new Container myobj = o1.addobj() # the assignment will create another copy myobj.x = 100 myobj.y = 200 myobj.z = 300 see o1.aobjs[1] # print the object inside the container see myobj # print the copy Class Container aObjs = [] func addobj aobjs + new point return aobjs[len(aobjs)] # return object by reference Class point x = 10 y = 20 z = 30 Output: x: 10.000000 y: 20.000000 z: 30.000000 x: 100.000000 y: 200.000000 z: 300.000000 42.2. Composition and Returning Objects and Lists by Reference 275
- 299. Ring Documentation, Release1.4.1 Example(2): func main o1 = new screen { content[point()] { x = 100 y = 200 z = 300 } content[point()] { x = 50 y = 150 z = 250 } } see o1.content[1] see o1.content[2] Class Screen content = [] func point content + new point return len(content) Class point x = 10 y = 20 z = 30 Output: x: 100.000000 y: 200.000000 z: 300.000000 x: 50.000000 y: 150.000000 z: 250.000000 Example(3): func main o1 = New Screen { point() { # access the object using reference x = 100 y = 200 z = 300 } point() { # access the object using reference x = 50 y = 150 z = 250 } } see o1.content[1] see o1.content[2] Class Screen content = [] func point content + new point 42.2. Composition and Returning Objects and Lists by Reference 276
- 300. Ring Documentation, Release1.4.1 return content[len(content)] # return the object by reference Class point x=10 y=20 z=30 Output: x: 100.000000 y: 200.000000 z: 300.000000 x: 50.000000 y: 150.000000 z: 250.000000 42.3 Executing code after the end of object access We can access an object using { } to use object attributes and methods. if the object contains a method called BraceEnd(), it will be executed before the end of the object access. Example: New Point { See "How are you?" + nl } Class Point x y z func braceend see "I'm fine, Thank you!" + nl Output: How are you? I'm fine, Thank you! 42.4 Declarative Programming on the top of Object-Oriented The next features enable us to build and use declartive programming environment using nested structures on the top of object oriented • using {} to access the object attributes and methods • BraceEnd() Method • returning objects by reference • Setter/Getter Methods (optional) Example: # Declartive Programming (Nested Structures) Screen() { point() { x = 100 y = 200 z = 300 42.3. Executing code after the end of object access 277
- 301. Ring Documentation, Release1.4.1 } point() { x = 50 y = 150 z = 250 } } # Functions and Classes Func screen return new screen Class Screen content = [] func point content + new point return content[len(content)] func braceend see "I have " + len(content) + " points!" Class point x=10 y=20 z=30 func braceend see self Output: x: 100.000000 y: 200.000000 z: 300.000000 x: 50.000000 y: 150.000000 z: 250.000000 I have 2 points! 42.5 More beautiful Code We can get better results and a more beautiful code when we can avoid writing () after the method name when the methods doesn’t take parameters. This feature is not provided directly by the Ring language because there is a difference between object methods and object attributes. We can get a similar effect on the syntax of the code when we define a getter method for the object attribute. For example instead of defining the point() method. we will define the point attribute then the getpoint() method that will be executed once you try to get the value of the point attribute. since we write the variable name direcly without () we can write point instead of point() and the method getpoint() will create the object and return the object reference for us. Example: new Container { 42.5. More beautiful Code 278
- 302. Ring Documentation, Release1.4.1 Point { x=10 y=20 z=30 } } Class Container aObjs = [] point func getpoint aObjs + new Point return aObjs[len(aObjs)] Class Point x y z func braceend see "3D Point" + nl + x + nl + y + nl + z + nl Output 3D Point 10 20 30 42.5. More beautiful Code 279
- 303. CHAPTER FORTYTHREE NATURAL LANGUAGE PROGRAMMING Usingthe Ring programming language, we can create Natural programming languages based on classes and objects. 43.1 History In 2010, I developed a new programming language called Supernova (developed using PWCT). This language uses a code that looks similar to Natural Language statements to create simple GUI applications. Now after five years, In the Ring programming language, we can get similar results, but now we have the ability to create/use code similar to Natural language statements in any domain that we like or need. The Ring programming language comes with the Supernova sprite, but with more generalization and with mix of other languages sprites. 43.2 Example The next example presents how to create a class that define two instructions The first instruction is : I want window The second instruction is : Window title = <expr> Also keywords that can be ignored like the ‘the’ keyword New App { I want window The window title = "hello world" } Class App # Attributes for the instruction I want window i want window nIwantwindow = 0 # Attributes for the instruction Window title # Here we don't define the window attribute again title nWindowTitle = 0 # Keywords to ignore, just give them any value the=0 func geti 280
- 304. Ring Documentation, Release1.4.1 if nIwantwindow = 0 nIwantwindow++ ok func getwant if nIwantwindow = 1 nIwantwindow++ ok func getwindow if nIwantwindow = 2 nIwantwindow= 0 see "Instruction : I want window" + nl ok if nWindowTitle = 0 nWindowTitle++ ok func settitle cValue if nWindowTitle = 1 nWindowTitle=0 see "Instruction : Window Title = " + cValue + nl ok Output: Instruction : I want window Instruction : Window Title = hello world 43.3 Change the Ring Keyword ‘And’ What if we want to connect between the two instructions using ‘and’ We have a problem because in Ring ‘and’ is a keyword We can change that using the ChangeRingKeyword command. Syntax: ChangeRingKeyword <oldkeyword> <newkeyword> Note: remember to restore the keyword again Tip: The ChangeRingKeyword command is executed in the scanner stage by the compiler (before parsing). Example: ChangeRingKeyword and _and New App { I want window and the window title = "hello world" } Class App 43.3. Change the Ring Keyword ‘And’ 281
- 305. Ring Documentation, Release1.4.1 # Attributes for the instruction I want window i want window nIwantwindow = 0 # Attributes for the instruction Window title # Here we don't define the window attribute again title nWindowTitle = 0 # Keywords to ignore, just give them any value the=0 and=0 ChangeRingKeyword _and and func geti if nIwantwindow = 0 nIwantwindow++ ok func getwant if nIwantwindow = 1 nIwantwindow++ ok func getwindow if nIwantwindow = 2 nIwantwindow= 0 see "Instruction : I want window" + nl ok if nWindowTitle = 0 nWindowTitle++ ok func settitle cValue if nWindowTitle = 1 nWindowTitle=0 see "Instruction : Window Title = " + cValue + nl ok func getand see "Using : and" + nl Output: Instruction : I want window Using : and Instruction : Window Title = hello world 43.4 Change the Ring Operator ‘+’ What if we want to define a new behavior for any operator like the “+” operator. We can do this change using the ChangeRingOperator command to hide operator (change it’s name) Then we can use the operator as identifier that we can handle it’s behaviour Syntax: 43.4. Change the Ring Operator ‘+’ 282
- 306. Ring Documentation, Release1.4.1 ChangeRingOperator <oldoperator> <newoperator> Note: remember to restore the operator again Tip: The ChangeRingOperator command is executed in the scanner stage by the compiler (before parsing). Example: ChangeRingOperator + _+ New App { + } Class App + func get+ see "Plus operator" ChangeRingOperator _+ + Output: Plus operator 43.5 Change the ‘=’ operator to ‘is’ Example: ChangeRingKeyword and _and ChangeRingOperator = is New App { I want window and the window title is "hello world" } ChangeRingOperator is = Class App # Attributes for the instruction I want window i want window nIwantwindow = 0 # Attributes for the instruction Window title # Here we don't define the window attribute again title nWindowTitle = 0 # Keywords to ignore, just give them any value the=0 and=0 ChangeRingKeyword _and and func geti if nIwantwindow = 0 43.5. Change the ‘=’ operator to ‘is’ 283
- 307. Ring Documentation, Release1.4.1 nIwantwindow++ ok func getwant if nIwantwindow = 1 nIwantwindow++ ok func getwindow if nIwantwindow = 2 nIwantwindow= 0 see "Instruction : I want window" + nl ok if nWindowTitle = 0 nWindowTitle++ ok func settitle cValue if nWindowTitle = 1 nWindowTitle=0 see "Instruction : Window Title = " + cValue + nl ok 43.6 Using Eval() with our Natural Code Example: func Main cProgram = ' I want window and the window title is "hello world" ' MyLanguage(cProgram) Func MyLanguage cCode # We add to the code the instructions that change keywords and operators # Because Eval() uses a new Compiler Object (the original keywords and operatos). cCode = ' ChangeRingKeyword and _and ChangeRingOperator = is ' + cCode New App { eval(cCode) } Class App # Attributes for the instruction I want window i want window nIwantwindow = 0 # Attributes for the instruction Window title # Here we don't define the window attribute again 43.6. Using Eval() with our Natural Code 284
- 308. Ring Documentation, Release1.4.1 title nWindowTitle = 0 # Keywords to ignore, just give them any value the=0 ChangeRingKeyword and _and and=0 ChangeRingKeyword _and and func geti if nIwantwindow = 0 nIwantwindow++ ok func getwant if nIwantwindow = 1 nIwantwindow++ ok func getwindow if nIwantwindow = 2 nIwantwindow= 0 see "Instruction : I want window" + nl ok if nWindowTitle = 0 nWindowTitle++ ok func settitle cValue if nWindowTitle = 1 nWindowTitle=0 see "Instruction : Window Title = " + cValue + nl ok 43.7 BraceStart and BraceEnd Methods We can write code that will be executed before/after using { } Example: o1 = new test { see "Hello" + nl } o1 {} class test func bracestart see "start" + nl func braceend see "end" + nl Output: 43.7. BraceStart and BraceEnd Methods 285
- 309. Ring Documentation, Release1.4.1 start Hello end start end 43.8 BraceExprEval Method The next example demonstrates how to use the “BraceExprEval” method to get expressions in Natural code. Example: new natural { create 5 } class natural create=0 lkeyword = false func braceexpreval r if lkeyword lkeyword=false return ok see "expr eval" + nl see "type: " + type(r) see nl see "value : " see r see nl func getcreate lkeyword = true see "create" + nl Output: create expr eval type: NUMBER value : 5 43.9 Real Natural Code The next example is a more advanced example # Natural Code new program { Accept 2 numbers then print the sum } # Natural Code Implementation class program # Keywords Accept=0 numbers=0 then=0 print=0 the=0 sum=0 # Execution func braceexpreval x value = x func getnumbers for x=1 to value see "Enter Number ("+x+") :" give nNumber 43.8. BraceExprEval Method 286
- 310. Ring Documentation, Release1.4.1 aNumbers + nNumber next func getsum nSUm = 0 for x in aNumbers nSum+= x next see "The Sum : " + nSum private value=0 aNumbers=[] Output: Enter Number (1) :3 Enter Number (2) :4 The Sum : 7 43.10 BraceError() Method The next examples demonstrates how to use the “BraceError” method to handle errors when accessing the object using braces {}. Example: func main o1 = new point { x=10 y=20 z=30 TEST SEE test } class point x y z func braceerror see "Handle Error!" + nl SEE "Message :" + cCatchError + nl if ( left(cCatchError,11) = "Error (R24)" ) and not isattribute(self,"test") see "add attribute" + nl addattribute(self,"test") test = 10 ok see "done" + nl return Output: Handle Error! Message :Error (R24) : Using uninitialized variable : test add attribute done 10 Example: new point { x=10 y=20 z=30 test() see "mmm..." + NL } 43.10. BraceError() Method 287
- 311. Ring Documentation, Release1.4.1 class point x y z func braceerror see "Handle Error!" + nl see "Message :" + cCatchError + nl see self see "Done" + NL Output: Handle Error! Message :Error (R3) : Calling Function without definition !: test x: 10.000000 y: 20.000000 z: 30.000000 Done mmm... 43.11 Clean Natural Code Instead of typing the literal as “literal” we can accept the words directly. Example: The next example accept hello world instead of “hello world” But this example uses braceend() to check the end of the instruction This means that this class process only one natural statement that end with literal. ChangeRingKeyword and _and New App { I want window and the window title is hello world } Class App # Attributes for the instruction I want window i want window nIwantwindow = 0 # Attributes for the instruction Window title # Here we don't define the window attribute again title is nWindowTitle = 0 # Keywords to ignore, just give them any value the=0 and=0 # Data literal = "" ChangeRingKeyword _and and func geti if nIwantwindow = 0 nIwantwindow++ ok func getwant 43.11. Clean Natural Code 288
- 312. Ring Documentation, Release1.4.1 if nIwantwindow = 1 nIwantwindow++ ok func getwindow if nIwantwindow = 2 nIwantwindow= 0 see "Instruction : I want window" + nl ok if nWindowTitle = 0 nWindowTitle++ ok func gettitle if nWindowTitle = 1 nWindowTitle=2 ok func getis if nWindowTitle = 2 nWindowTitle=3 ok func braceend if nWindowTitle = 3 see "Instruction : Window Title = " + literal + nl nWindowTitle = 0 ok func braceerror c= substr(cCatchError,":") while c > 0 c= substr(cCatchError,":") cCatchError=substr(cCatchError,c+1) end literal += substr(cCatchError,1) 43.11. Clean Natural Code 289
- 313. CHAPTER FORTYFOUR USING THE NATURALLIBRARY In this chapter we will learn how to use the Natural Library to quickly define a language that contains a group of commands. To start using the library, We need to call naturallib.ring load "naturallib.ring" After loading the library, We can use the NaturalLanguage class that contains the next methods :- • SetLanguageName(cLanguageName) • setCommandsPath(cFolder) • SetPackageName(cPackageName) • UseCommand(cCommandName) • SetOperators(cOperators) • RunFile(cFileName) • RunString(cString) 44.1 Natural Library - Demo Program We will write the natural code in a Text file, for example program.txt File: program.txt Welcome to the Ring programming language! What you are reading now is not comments, I swear! After many years of programming I decided to think different about programming and solve the problems in a better way. We are writing commands or code and the Ring language is reading it to understand us! Sure, What you are seeing now is just ***part of the code - Not the Complete Program*** You have to write little things before and after this part to be able to run it! It is the natural part of our code where we can write in English, Arabic or any Natural Language Then we will tell the computer through the Ring language what must happens! in a way that we can scale for large frameworks and programs. 290
- 314. Ring Documentation, Release1.4.1 Just imagine what will happens to the world of programming once we create many powerful frameworks using the Ring language that uses this way (Natural Programming). For example When we say Hello to the Machine, It can reply! and when we say count from 1 to 5 it will understand us, Also if we said count from 5 to 1 it will understand us too! You can see the Output window! This Goal is not new, but the Ring language comes with an innovative solution to this problem. Output: Hello, Sire! The Numbers! 1 2 3 4 5 I will count Again! 5 4 3 2 1 To execute the natural code, We have start.ring In start.ring we define the language and the commands. File: start.ring load "stdlib.ring" load "naturallib.ring" New NaturalLanguage { SetLanguageName(:MyLanguage) SetCommandsPath(CurrentDir()+"/../command") SetPackageName("MyLanguage.Natural") UseCommand(:Hello) UseCommand(:Count) RunFile("program.txt") } We defined a language called MyLanguage, We have folder for the language commands. 44.1. Natural Library - Demo Program 291
- 315. Ring Documentation, Release1.4.1 Each command will define a class that belong to the MyLanguage.Natural package. We will define two commands, Hello and Count. So we must have two files for defining the commands in the CurrentDir()+”/../command” folder File: hello.ring DefineNaturalCommand.SyntaxIsKeyword([ :Package = "MyLanguage.Natural", :Keyword = :hello, :Function = func { See "Hello, Sire!" + nl + nl } ]) File: count.ring DefineNaturalCommand.SyntaxIsKeywordNumberNumber([ :Package = "MyLanguage.Natural", :Keyword = :count, :Function = func { if not isattribute(self,:count_times) { AddAttribute(self,:count_times) Count_Times = 0 } if Expr(1) > Expr(2) { nStep = -1 else nStep = 1 } if Count_Times = 0 { see nl+"The Numbers!" + nl Count_Times++ else see nl + "I will count Again!" +nl } for x = Expr(1) to Expr(2) step nStep { see nl+x+nl } CommandReturn(fabs(Expr(1)-Expr(2))+1) } ]) 44.2 Defining Commands To define new command we can use the DefineNaturalCommand object This object provides the next methods :- • SyntaxIsKeyword(aPara) • SyntaxIsKeywordNumber(aPara) • SyntaxIsKeywordNumberNumber(aPara) • SyntaxIsKeywordNumbers(aPara,nCount) • SyntaxIsKeywordString(aPara) • SyntaxIsKeywordStringString(aPara) 44.2. Defining Commands 292
- 316. Ring Documentation, Release1.4.1 • SyntaxIsKeywordStrings(aPara,nCount) • SyntaxIsKeywordExpression(aPara) • SyntaxIsKeywordExpressionExpression(aPara) • SyntaxIsKeywordExpressions(aPara,nCount) • SyntaxIsCommand(aPara) • SyntaxIsCommandNumber(aPara) • SyntaxIsCommandNumberNumber(aPara) • SyntaxIsCommandNumbers(aPara,nCount) • SyntaxIsCommandString(aPara) • SyntaxIsCommandStringString(aPara) • SyntaxIsCommandStrings(aPara,nCount) • SyntaxIsCommandExpression(aPara) • SyntaxIsCommandExpressionExpression(aPara) • SyntaxIsCommandExpressions(aPara,nCount) File: mylanguage.ring load "stdlib.ring" load "naturallib.ring" MyLanguage = New NaturalLanguage { SetLanguageName(:MyLanguage) setCommandsPath(CurrentDir()+"/../command") SetPackageName("MyLanguage.Natural") UseCommand(:Hello) UseCommand(:Count) UseCommand(:Print) UseCommand(:IWantWindow) UseCommand(:WindowTitleIs) UseCommand(:IWantButton) } Example (1) In the next example we will define the Print command. We will use the SyntaxIsKeywordExpression() Method. We pass list (as Hash) to the method. We determine the package name, the keyword and the function that will be executed. Inside this function we uses the Expr(nExprNumber) function to get the expression value that the user will write after the keyword. File: print.ring DefineNaturalCommand.SyntaxIsKeywordExpression([ :Package = "MyLanguage.Natural", :Keyword = :print, :Function = func { See Expr(1) } ]) 44.2. Defining Commands 293
- 317. Ring Documentation, Release1.4.1 Usage: load "mylanguage.ring" MyLanguage.RunString(' print "Hello, World!" ') Output: Hello, World! Example (2) File: iwantwindow.ring DefineNaturalCommand.SyntaxIsCommand([ :Package = "MyLanguage.Natural", :Command = "i want window", :Function = func { See "Command: I want window" + nl } ]) Usage: load "mylanguage.ring" MyLanguage.RunString(' i want window ') Output: Command: I want window Example (3) File: windowtitleis.ring DefineNaturalCommand.SyntaxIsCommandString([ :Package = "MyLanguage.Natural", :Command = "window title is", :Function = func { See "Command: Window title is " + Expr(1) + nl } ]) Usage: load "mylanguage.ring" MyLanguage.RunString(' I want window and the window title is "Hello World" ') Output: Command: I want window Command: Window title is Hello World 44.2. Defining Commands 294
- 318. Ring Documentation, Release1.4.1 44.3 Natural Library - Operators In the next example we uses the Count command without using operators load "mylanguage.ring" MyLanguage.RunString(" Hello Count 1 5 Count 5 1 ") We can add more description load "mylanguage.ring" MyLanguage.RunString(" Hello, Please Count from 1 to 5 then count from 5 to 1 ") Also we can use operators like “(” and ”)” around the instruction load "mylanguage.ring" MyLanguage { SetOperators("()") RunString(" Here we will play and will try something that looks like Lisp Syntax (count (count 1 5) (count 20 15)) Just for fun! ") } 44.4 Defining commands using classes This section is related to the implementation details. When we define new command, Each command is defined by the Natural Library as a class. We have the choice to define commands using the simple interface provided by the DefineNaturalCommand object or by defining new class as in the next examples. If we used DefineNaturalCommand (More Simple), The class will be defined during the runtime. File: hello.ring Package MyLanguage.Natural class Hello func AddAttributes_Hello AddAttribute(self,:hello) func GetHello See "Hello, Sire!" + nl + nl File: count.ring 44.3. Natural Library - Operators 295
- 319. Ring Documentation, Release1.4.1 Package MyLanguage.Natural class Count func Getcount StartCommand() CommandData()[:name] = :Count CommandData()[:nExpr] = 0 CommandData()[:aExpr] = [] func BraceExprEval_Count nValue if isCommand() and CommandData()[:name] = :Count { if isNumber(nValue) { CommandData()[:nExpr]++ CommandData()[:aExpr] + nValue if CommandData()[:nExpr] = 2 { Count_Execute() } } } func AddAttributes_Count AddAttribute(self,:count) func Count_Execute if not isattribute(self,:count_times) { AddAttribute(self,:count_times) Count_Times = 0 } if Expr(1) > Expr(2) { nStep = -1 else nStep = 1 } if Count_Times = 0 { see nl+"The Numbers!" + nl Count_Times++ else see nl + "I will count Again!" +nl } for x = Expr(1) to Expr(2) step nStep { see nl+x+nl } CommandReturn(fabs(Expr(1)-Expr(2))+1) 44.4. Defining commands using classes 296
- 320. CHAPTER FORTYFIVE WEB DEVELOPMENT (CGILIBRARY) In this chapter we will learn about developing Web applications using a CGI Library written in the Ring language. 45.1 Configure the Apache web server We can use Ring with any web server that support CGI. In this section we will learn about using Ring with the Apache HTTP Server. You can download Apache from : http://httpd.apache.org/ Or you can get it included with other projects like XAMPP : https://www.apachefriends.org/download.html Install then open the file: xamppapacheconfhttpd.conf search for <Directory /> Then after it add Options FollowSymLinks +ExecCGI So we have <Directory /> Options FollowSymLinks +ExecCGI Search for the next line and be sure that it’s not commented LoadModule cgi_module modules/mod_cgi.so Search for : AddHandler cgi-script Then add ”.ring” to the supported cgi extensions Example AddHandler cgi-script .cgi .ring Example AddHandler cgi-script .cgi .pl .asp .ring 297
- 321. Ring Documentation, Release1.4.1 Run/Start the server Create your web applications in a directory supported by the web server. Example: Apache2.2htdocsmywebapplicationfolder Example: xampphtdocsmywebapplicationfolder Inside the source code file (*.ring), Add this line #!c:ringbinring.exe -cgi Note: Change the previous line based on the path to ring.exe in your machine 45.2 Ring CGI Hello World Program The next program is the Hello World program #!c:ringbinring.exe -cgi See "content-type : text/html" +nl+nl+ "Hello World!" + nl 45.3 Hello World Program using the Web Library We can use the web library to write CGI Web applications quickly Example (1) : #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { Text("Hello World!") } Example (2) : #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web WebPage() { Text("Hello World!") } 45.2. Ring CGI Hello World Program 298
- 322. Ring Documentation, Release1.4.1 Tip: the difference between ex. 1 and ex. 2 is using WebPage() function to return the page object instead of creating the object using new statement. 45.4 Web Library Features The next features are provided by the Web library to quickly create web applications. • Generate HTML pages using functions • Generate HTML pages using objects • HTTP Get • HTTP Post • Files Upload • URL Encode • Templates • CRUD MVC Sample • Users Logic & Registration Sample 45.5 HTTP Get Example The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { Title = "Test HTTP Get" divstart([ :style = StyleSizeFull() ] ) boxstart() text( "Test HTTP GET" ) newline() boxend() divstart([ :style = Styledivcenter("600px","550px") + StyleGradient(21) ]) divstart([:style = stylefloatleft() + stylesize("100px","100%") + stylecolor("black") + stylegradient(58)]) formstart("ex5.ring") tablestart([ :style = stylesize("65%","90%") + stylemarginleft("35%") + stylemargintop("30%") ]) rowstart([]) cellstart([]) text ( "Name : " ) cellend() cellstart([]) cTextboxStyle = StyleMarginLeft("5%") + StyleWidth("250px") + StyleColor("black") + 45.4. Web Library Features 299
- 323. Ring Documentation, Release1.4.1 StyleBackColor("white") textbox([ :name = "Name", :style = cTextboxStyle ] ) cellend() rowend() rowstart([]) cellstart([]) text ( "Address : " ) cellend() cellstart([]) textbox([ :name = "Address", :style = cTextboxStyle] ) cellend() rowend() rowstart([]) cellstart([]) text ( "Phone : " ) cellend() cellstart([]) textbox([ :name = "Phone", :style = cTextboxStyle ]) cellend() rowend() rowstart([]) cellstart([]) text ( "Age : " ) cellend() cellstart([]) textbox([ :name = "Age", :style = cTextboxStyle ]) cellend() rowend() rowstart([]) cellstart([]) text ( "City: " ) cellend() cellstart([]) listbox([ :name = "City", :items = ["Cairo","Riyadh","Jeddah"], :style = stylemarginleft("5%") + stylewidth("400px") ] ) cellend() rowend() rowstart([]) cellstart([]) text ( "Country : " ) cellend() cellstart([]) combobox([ :name = "Country", :items = ["Egypt","Saudi Arabia","USA"], :style = stylemarginleft("5%") + stylewidth("400px")+ stylecolor("black")+ stylebackcolor("white")+ stylefontsize("14px") ]) cellend() rowend() rowstart([]) cellstart([]) text ( "Note : " ) cellend() cellstart([]) editbox([ :name = "Notes", :style = stylemarginleft("5%") + 45.5. HTTP Get Example 300
- 324. Ring Documentation, Release1.4.1 stylesize("400px","100px")+ stylecolor("black")+ stylebackcolor("white") , :value = "write comments here..." ] ) cellend() rowend() rowstart([]) cellstart([]) cellend() cellstart([]) submit([ :value = "Send" , :Style = stylemarginleft("5%") ]) cellend() rowend() tableend() formend() divend() divend() divend() } Screen Shot: 45.5. HTTP Get Example 301
- 325. Ring Documentation, Release1.4.1 The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { divstart([ :style = styledivcenter("800px","500px") ]) boxstart() text ( "HTTP GET Response" ) newline() boxend() divstart([ :style = stylefloatleft()+stylewidth("10%")+ 45.5. HTTP Get Example 302
- 326. Ring Documentation, Release1.4.1 stylecolor("black")+stylegradient(58) ]) newline() text ( "Name : " ) newline() newline() text ( "Address : " ) newline() newline() text ( "Phone : " ) newline() newline() text ( "Age : " ) newline() newline() text ( "City : " ) newline() newline() text ( "Country : " ) newline() newline() text ( "Note : " ) newline() newline() divend() divstart([ :style = stylefloatleft()+stylewidth("90%")+ stylecolor("black")+stylegradient(47) ]) divstart([ :style = stylefloatleft() + stylewidth("1%") ]) newline() divend() divstart([ :style = stylefloatleft() + stylewidth("95%") ]) newline() text ( aPageVars["Name"] ) newline() newline() text ( aPageVars["Address"] ) newline() newline() text ( aPageVars["Phone"] ) newline() newline() text ( aPageVars["Age"] ) newline() newline() text ( aPageVars["City"] ) newline() newline() text (aPageVars["Country"] ) newline() newline() text ( aPageVars["Notes"] ) newline() newline() divend() divend() divend() } Screen Shot: 45.5. HTTP Get Example 303
- 327. Ring Documentation, Release1.4.1 45.6 HTTP POST Example The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Post Test") newline() boxend() divstart([ :style=StyleFloatLeft()+StyleWidth("100px") ]) newline() text( "Number1 : " ) newline() newline() text( "Number2 : " ) newline() newline() divend() formpost("ex7.ring") divstart([ :style = styleFloatLeft()+StyleWidth("200px") ]) newline() textbox([ :name = "Number1" ]) newline() newline() textbox([ :name = "Number2" ]) newline() newline() submit([ :value = "Send" ] ) divend() formend() } Screen Shot: 45.6. HTTP POST Example 304
- 328. Ring Documentation, Release1.4.1 The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Post Result" ) newline() boxend() divstart([ :style = styleFloatLeft()+styleWidth("200px") ]) newline() text( "Number1 : " + aPageVars["Number1"] ) newline() newline() text( "Number2 : " + aPageVars["Number2"] ) newline() newline() text( "Sum : " + (0 + aPageVars["Number1"] + aPageVars["Number2"] ) ) newline() divend() } Screen Shot: 45.6. HTTP POST Example 305
- 329. Ring Documentation, Release1.4.1 45.7 Upload Files The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New page { boxstart() text( "Upload File" ) newline() boxend() for x = 1 to 3 newline() next formupload("ex9.ring") text( "Customer Name : " ) textbox([ :name = "custname" ]) newline() newline() divstart([ :style = styleFloatLeft() + styleWidth("90px") ]) uploadfile("file") newline() newline() uploadfile("file2") newline() newline() submit([ :value = "Send" ]) divend() formend() } Screen Shot: 45.7. Upload Files 306
- 330. Ring Documentation, Release1.4.1 The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web cUploadPath = "C:/Apache2.2/htdocs/ringapp/upload/" cUploadFolder = "/ringapp/upload/" New page { boxstart() text( "Upload Result" ) newline() boxend() newline() divstart([ :style= styleFloatLeft() + styleWidth("100px") ]) text( "Name : " + aPageVars["custname"] ) newline() divend() if aPageVars["file"] != char(13) getuploadedfile(self,"file") ok if aPageVars["file2"] != char(13) getuploadedfile(self,"file2") ok } Func getuploadedfile oObj,cFile # here we use object.property # instead of object { } to avoid executing braceend method cFileName = cUploadPath + oObj.getfilename(aPageVars,cFile) 45.7. Upload Files 307
- 331. Ring Documentation, Release1.4.1 write(cFileName,aPageVars[cFile]) system("chmod a+x "+cFileName) oObj.newline() oObj.text( "File "+cFileName+ " Uploaded ..." ) oObj.newline() imageURL = cUploadFolder+oObj.getfilename(aPageVars,cFile) oObj.link([ :url = imageURL, :title = "Download" ]) oObj.newline() oObj.image( [ :url = imageURL , :alt = :image ] ) oObj.newline() Screen Shot: 45.7. Upload Files 308
- 332. Ring Documentation, Release1.4.1 45.8 Cookies The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" 45.8. Cookies 309
- 333. Ring Documentation, Release1.4.1 Import System.Web New page { boxstart() text( "Cookie Test" ) newline() boxend() newline() link([ :url = "ex11.ring", :title = "Use Cookies" ]) cookie("custname","Mahmoud Fayed") cookie("custage",28) } Screen Shot: The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Cookies Values" ) newline() boxend() link([ :url = "ex10.ring", :title = "back" ]) newline() divstart([:style="float:left;width:200px"]) text( "Name : " + aPageVars["custname"] ) newline() text( "Age : " + aPageVars["custage"] ) newline() divend() } Screen Shot: 45.8. Cookies 310
- 334. Ring Documentation, Release1.4.1 45.9 URL Encode The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "URLEncode" ) newline() boxend() link([ :url = "ex5.ring?Name="+URLEncode("-*{Mahmoud}*-")+ "&Address=Egypt&Phone=123456&Age=28&Notes=Programmer", :title = "Test URL Encode" ]) } Screen Shot: Screen Shot: 45.9. URL Encode 311
- 335. Ring Documentation, Release1.4.1 45.10 Templates Using Templates we can write Ring code inside HTML files Syntax: <%= Ring Expression %> <% Ring Statements %> The HTML Code <h1>Listing Numbers</h1> <table> <tr> <th> <%= myheader.cColumn1 %> </th> <th> <%= myheader.cColumn2 %> </th> <th></th> <th></th> <th></th> </tr> <% for x in aNumbers %> <tr> <td> <%= x.nValue %> </td> <td> <%= x.nSquare %> </td> </tr> <% next %> </table> The Ring Code #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New NumbersController { start() } 45.10. Templates 312
- 336. Ring Documentation, Release1.4.1 Class NumbersController MyHeader aNumbers Func Start MyHeader = New Header { cColumn1 = "Number" cColumn2 = "Square" } aNumbers = list(20) for x = 1 to len(aNumbers) aNumbers[x] = new number { nValue = x nSquare = x*x } next cTemp = Template("mynumbers.html",self) New Page { boxstart() text( "Test Templates" ) newline() boxend() html(cTemp) } Class Header cColumn1 cColumn2 Class Number nValue nSquare Screen Shot: 45.10. Templates 313
- 337. Ring Documentation, Release1.4.1 45.11 HTML Special Characters The text() function display HTML special characters. If you want to write html code, use the html() function. 45.11. HTML Special Characters 314
- 338. Ring Documentation, Release1.4.1 #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text("HTML Special Characters") newline() boxend() text(' <html> <body> <p> "hello world" </p> </body> </html> ') } Screen Shot: 45.12 Hash Functions The Page User Interface #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Hash Test") newline() boxend() divstart([ :style = StyleFloatLeft() + StyleWidth("100px") ]) newline() text( "Value : " ) newline() newline() divend() formpost("ex16.ring") divstart([ :style = StyleFloatLeft() + StyleWidth("300px") ]) newline() 45.12. Hash Functions 315
- 339. Ring Documentation, Release1.4.1 textbox([ :name = "Value" ]) newline() newline() submit([ :value = "Send" ]) divend() formend() } Screen Shot: The Response #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web New Page { boxstart() text( "Hash Result" ) newline() boxend() divstart([ :style = styleFloatLeft() + styleWidth("100%") ]) newline() text( "Value : " + aPageVars["Value"] ) newline() text( "MD5 : " + MD5(aPageVars["Value"]) ) newline() text( "SHA1 : " + SHA1(aPageVars["Value"]) ) newline() text( "SHA256 : " + SHA256(aPageVars["Value"]) ) newline() text( "SHA224 : " + SHA224(aPageVars["Value"]) ) newline() text( "SHA384 : " + SHA384(aPageVars["Value"]) ) newline() text( "SHA512 : " + SHA512(aPageVars["Value"]) ) newline() divend() } Screen Shot: 45.12. Hash Functions 316
- 340. Ring Documentation, Release1.4.1 45.13 Random Image #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web cUploadPath = "C:/Apache2.2/htdocs/ringapp/upload/" New Page { boxstart() text( "Random Test") newline() boxend() divstart([ :style = styleFloatLeft() + styleWidth("400px") ]) newline() aList = dir(cUploadPath) if len(aList) > 0 nIndex = random(len(aList)) if nindex = 0 nIndex = 1 ok cItem = "upload/" + aList[nIndex][1] newline() image( [ :url = cItem , :alt = :image ] ) else text("No images!") newline() ok divend() } Screen Shot: 45.13. Random Image 317
- 341. Ring Documentation, Release1.4.1 45.14 HTML Lists The next example print a list contains numbers from 1 to 10 Then print a list from Ring List. Finally we have a list of buttons and when we press on a button we get a message contains the clicked button number. To start the list we uses the ulstart() function. To end the list we uses the ulend() function. We uses listart() and liend() to determine the list item. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main New Page { ulstart([]) for x = 1 to 10 listart([]) text(x) liend() next ulend() list2ul(["one","two","three","four","five"]) ulstart([]) for x = 1 to 10 listart([]) 45.14. HTML Lists 318
- 342. Ring Documentation, Release1.4.1 cFuncName = "btn"+x+"()" button([ :onclick = cFuncName , :value = x]) script(scriptfuncalert(cFuncName,string(x))) liend() next ulend() } Screen Shot: 45.14. HTML Lists 319
- 343. Ring Documentation, Release1.4.1 45.15 HTML Tables In this example we will learn how to generate HTML tables using the tablestart(), tableend(), rowstart(), rowend() ,headerstart(), headerend(), cellstart() and cellend() functions. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main New Page { divstart([ :style = styledivcenter("400px","500px") ] ) style(styletable() + styletablerows("t01")) tablestart([ :id = :t01 , :style = stylewidth("100%") ]) rowstart([]) headerstart([]) text("Number") headerend() headerstart([]) text("square") headerend() rowend() for x = 1 to 10 rowstart([]) cellstart([]) text(x) cellend() cellstart([]) text(x*x) cellend() rowend() next tableend() divend() } Screen Shot: 45.15. HTML Tables 320
- 344. Ring Documentation, Release1.4.1 45.16 Gradient In this example we will learn how to use the StyleGradient() function. The function takes the style number as input (range from 1 to 60). #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main New Page { boxstart() text("StyleGradient() Function") boxend() for x = 1 to 60 divstart([ :id = x , :align = "center" , :style = stylefloatleft() + stylesize(string(100/60*6)+"%","50px") + stylegradient(x) ]) h3(x) divend() next } Screen Shot: 45.16. Gradient 321
- 345. Ring Documentation, Release1.4.1 45.17 Generating Pages using Objects Instead of using functions/methods to generate HTML pages, we can use an object for each element in the page. This choice means more beautiful code but slower. The fastest method is to print HTML code directly, then using functions then using templates then using objects (slower). #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main WebPage() { Title = "Using objects to create the Web Page content" h1 { text("welcome") } link { Title = "Google" Link = "http://www.google.com" } div { id = "div1" style = stylegradient(30) + stylesize("50%","50%") text("Outer Div") div { id = "div2" color = "white" backgroundcolor = "green" width = "50%" height = "50%" marginleft = "5%" margintop = "5%" text("Inner Div") } } div { id = "div3" color = "black" backgroundcolor = "silver" width = "100%" height = "100%" text("Form") form { method = "POST" Action = "helloworld.ring" Table { style = stylewidth("100%") + stylegradient(24) TR { TD { WIDTH="10%" text("Name : " ) } 45.17. Generating Pages using Objects 322
- 346. Ring Documentation, Release1.4.1 TD { Input { type = "text" } } } TR { TD { WIDTH="10%" text("Email : " ) } TD { Input { type = "text" } } } TR { TD { WIDTH="10%" text("Password : " ) } TD { Input { type = "password" } } } TR { TD { WIDTH="10%" text("Notes") } TD { TextArea { width="100%" rows = 10 cols = 10 text("type text here...") } } } TR { TD { WIDTH="10%" text("Gender") } TD { select { width = "100%" option { text("Male") } option { text("Female") } } } } TR { TD { WIDTH="10%" text("Role") } TD { select { multiple = "multiple" width = "100%" option { text("student") } option { text("admin") } } } } } Input { type = "submit" value = "send" } Image { src="upload/profile1.jpg" alt="profile"} Input { type = "checkbox" value = "Old Member"} text("old member") Input { type = "range" min=1 max=100} Input { type = "number" min=1 max=100} Input { type = "radio" color="black" name="one" value = "one"} text("one") } } div { color = "white" 45.17. Generating Pages using Objects 323
- 347. Ring Documentation, Release1.4.1 backgroundcolor = "blue" width = "100%" UL { LI { TEXT("ONE") } LI { TEXT("TWO") } LI { TEXT("THREE") } } } div { audio { src = "horse.ogg" type = "audio/ogg" } video { width = 320 height = 240 src = "movie.mp4" type = "video/mp4" } Input { type = "color" value = "#ff0000" onchange = "clickColor(0, -1, -1, 5)" } } } Screen Shot: 45.17. Generating Pages using Objects 324
- 348. Ring Documentation, Release1.4.1 45.17. Generating Pages using Objects 325
- 349. Ring Documentation, Release1.4.1 45.18 Using Bootstrap Library using Functions The next example uses the Bootstrap JavaScript Library when generating the HTML page. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main new BootstrapPage { divstart([ :class = "container" ]) divstart([ :class = "jumbotron" ]) h1("Bootstrap Page") divend() 45.18. Using Bootstrap Library using Functions 326
- 350. Ring Documentation, Release1.4.1 divstart([ :class = :row ]) divstart([ :class = "col-sm-4" ]) h3("Welcome to the Ring programming language") p([ :text = "Using a scripting language is very fun!" ]) divend() divstart([ :class = "col-sm-4" ]) h3("Welcome to the Ring programming language") p([ :text = "using a scripting language is very fun!" ]) divend() divstart([ :class = "col-sm-4" ]) h3("Welcome to the Ring programming language") p([ :text = "using a scripting language is very fun!" ]) divend() divend() divend() } Screen Shot: 45.19 Using Bootstrap Library using Objects The next example uses the Bootstrap JavaScript Library when generating the HTML page. Instead of using functions to generate the HTML elements, we will use objects. #!c:ringbinring.exe -cgi Load "weblib.ring" Import System.Web Func Main 45.19. Using Bootstrap Library using Objects 327
- 351. Ring Documentation, Release1.4.1 BootStrapWebPage() { div { classname = :container div { classname = :jumbotron H1 { text("Bootstrap Page") } } div { classname = :row for x = 1 to 3 div { classname = "col-sm-4" H3 { html("Welcome to the Ring programming language") } P { html("Using a scripting language is very fun!") } } next } div { classname = :row div { classname = "col-sm-4" Button { classname = "btn btn-info btn-lg" datatoggle= "modal" datatarget = "#myModal" text("Open Large Modal") } } div { classname = "col-sm-4" Button { classname = "btn btn-default btn-lg" text("default") } Button { classname = "btn btn-primary btn-md" text("primary") } Button { classname = "btn btn-sucess btn-sm" text("sucess") } Button { classname = "btn btn-info btn-xs" text("info") } Button { classname = "btn btn-warning" text("warning") } Button { classname = "btn btn-danger" text("danger") } Button { classname = "btn btn-link" text("link") } } div { classname = "col-sm-4" Button { classname = "btn btn-default btn-block" text("default") } Button { classname = "btn btn-primary btn-block" text("primary") } Button { classname = "btn btn-sucess btn-block" text("sucess") } Button { classname = "btn btn-info btn-block" text("info") } Button { classname = "btn btn-warning btn-block" text("warning") } Button { classname = "btn btn-danger btn-block" text("danger") } Button { classname = "btn btn-link btn-block" text("link") } } 45.19. Using Bootstrap Library using Objects 328
- 352. Ring Documentation, Release1.4.1 div { classname = "col-sm-4" div { classname = "btn-group" button { classname="btn btn-primary" text("one") } button { classname="btn btn-primary" text("two") } button { classname="btn btn-primary" text("three") } } } div { classname = "col-sm-4" div { classname = "btn-group btn-group-lg" button { classname="btn btn-primary" text("one") } button { classname="btn btn-primary" text("two") } button { classname="btn btn-primary" text("three") } } } div { classname = "col-sm-4" div { classname = "btn-group-vertical btn-group-lg" button { classname="btn btn-primary" text("one") } button { classname="btn btn-primary" text("two") } button { classname="btn btn-primary" text("three") } } } } div { classname="modal fade" id="myModal" role="dialog" div { classname = "modal-dialog modal-lg" div { classname="modal-content" div { classname="modal-header" button { classname="close" datadismiss="modal" html("×") } h4 { classname="modal-title" text("Modal Header") } } div { classname = "modal-body" p { text("This is a large model.") } } div { classname="modal-footer" button { classname = "btn btn-default" datadismiss="modal" text("close") } } } } } } } Screen Shot: 45.19. Using Bootstrap Library using Objects 329
- 353. Ring Documentation, Release1.4.1 45.20 CRUD Example using MVC The next example uses the weblib.ring & datalib.ring. The datalib.ring contains classes for creating database applications using MVC pattern. In this example we create an object from the SalaryController class then call the Routing method. We define the website variable to contains the basic url of the page. When we create the SalaryModel class from the ModelBase class, the salary table will be opened and the columns data will be defined as attributes in the model class. The SalaryView class create an object from the SalaryLanguageEnglish class to be used for translation. The method AddFuncScript is used to call the form for adding/modifying record data. The method FormViewContent is used to determine the controls in the form when we add or modify a record. #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Import System.Web website = "ex24.ring" New SalaryController { Routing() } 45.20. CRUD Example using MVC 330
- 354. Ring Documentation, Release1.4.1 Class SalaryModel from ModelBase Class SalaryController From ControllerBase Class SalaryView From ViewBase oLanguage = new SalaryLanguageEnglish Func AddFuncScript oPage,oController return oPage.scriptfuncajax("myadd",oController.cMainURL+ oController.cOperation+"=add","mysubpage") Func FormViewContent oController,oTranslation,oPage return [ [ oTranslation.aColumnsTitles[2], "textbox", "name", oController.oModel.Name, oPage.stylewidth("100%") ], [ oTranslation.aColumnsTitles[3], "textbox", "salary", oController.oModel.Salary, oPage.stylewidth("50%") ] ] Class SalaryLanguageEnglish cTitle = "Salary Table" cBack = "back" aColumnsTitles = ["ID","Name","Salary"] cOptions = "Options" cSearch = "Search" comboitems = ["Select Option...","Edit","Delete"] cAddRecord = "Add Record" cEditRecord = "Edit Record" cRecordDeleted = "Record Deleted!" aMovePages = ["First","Prev","Next","Last"] cPage = "Page" cOf = "of" cRecordsCount = "Records Count" cSave = "Save" temp = new page cTextAlign = temp.StyleTextRight() cNoRecords = "No records!" Screen Shot: 45.20. CRUD Example using MVC 331
- 355. Ring Documentation, Release1.4.1 45.21 Users registration and Login We have the users classes (Model, View & Controller) to deal with the users data like username & email. The next code is stored in ex25_users.ring Class UsersModel from ModelBase cSearchColumn = "username" Class UsersController From ControllerBase 45.21. Users registration and Login 332
- 356. Ring Documentation, Release1.4.1 aColumnsNames = ["id","username","email"] Func UpdateRecord oModel.id = aPageVars[cRecID] oModel.updatecolumn("username", aPageVars[:username] ) oModel.updatecolumn("email", aPageVars[:email] ) oView.UpdateView(self) Class UsersView from ViewBase oLanguage = new UsersLanguageEnglish Func AddFuncScript oPage,oController return oPage.scriptfunc("myadd",oPage.scriptredirection("ex26.ring")) Func FormViewContent oController,oTranslation,oPage return [ [oTranslation.aColumnsTitles[2],"textbox","username", oController.oModel.UserName,oPage.stylewidth("100%")], [oTranslation.aColumnsTitles[3],"textbox","email", oController.oModel.Email,oPage.stylewidth("50%")] ] Class UsersLanguageEnglish cTitle = "Users Table" cBack = "back" aColumnsTitles = ["ID","User Name","Email"] cOptions = "Options" cSearch = "Search" comboitems = ["Select Option...","Edit","Delete"] cAddRecord = "Add Record" cEditRecord = "Edit Record" cRecordDeleted = "Record Deleted!" aMovePages = ["First","Prev","Next","Last"] cPage = "Page" cOf = "of" cRecordsCount = "Records Count" cSave = "Save" temp = new page cTextAlign = temp.StyleTextRight() cNoRecords = "No records!" In the file ex25.ring we load ex25_users.ring then create an object from UsersController class. Using the created object, we call the routing method. #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" Import System.Web website = "ex25.ring" New UsersController { Routing() } Screen Shot: 45.21. Users registration and Login 333
- 357. Ring Documentation, Release1.4.1 See the next code for the registration page #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Import System.Web website = "ex26.ring" new page { boxstart() text( "Register") newline() boxend() divstart([:style = stylegradient(6) + stylesize("100%","95%") ]) link([ :url = website, :title = "back" , :style = stylecolor("white")]) newline() divstart([ :style= styledivcenter("500","160") + stylegradient(52) ]) formpost("ex27.ring") tablestart([ :Style = stylemarginleft("2%") + stylemargintop("2%") + stylewidth("90%") ]) rowstart([]) cellstart([:style = stylewidth("20%") + styleheight(30)]) text("User Name") cellend() cellstart([ :style = stylewidth("80%") ]) textbox([:name = "username", :style = stylewidth("100%")]) cellend() rowend() rowstart([]) cellstart([ :Style = styleheight(30)]) text("Password") cellend() cellstart([]) textbox([:name = "password" , :type = "password"]) 45.21. Users registration and Login 334
- 358. Ring Documentation, Release1.4.1 cellend() rowend() rowstart([]) cellstart([ :style = styleheight(30)]) text("Email") cellend() cellstart([]) textbox([:name = "email" , :style = stylewidth("100%")]) cellend() rowend() rowstart([]) cellstart([ :style = styleheight(30)]) cellend() cellstart([ :style = styleheight(30)]) submit([:value = "Register" ]) cellend() rowend() tableend() formend() divend() divend() } Screen Shot: The Registration response #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" 45.21. Users registration and Login 335
- 359. Ring Documentation, Release1.4.1 Import System.Web oUser = new UsersModel oUser.Connect() if oUser.findwith("username",aPageVars["username"]) new page { text("The user name is already registered") } return ok if oUser.findwith("email",aPageVars["email"]) new page { text("This email is already registered") } return ok aPageVars["salt"] = str2hex(RandBytes(32)) aPageVars["pwhash"] = sha256(aPagevars["password"]+aPageVars["salt"]) aPageVars["sessionid"] = str2hex(randbytes(32)) oUser.Insert() new page { cookie("sessionid",aPageVars["sessionid"]) text("New User Created!") newline() text("User Name : " + aPageVars["username"]) newline() } oUser.Disconnect() See the next code for the Login page #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Import System.Web website = "ex28.ring" new page { boxstart() text( "Login") newline() boxend() divstart([:style = stylegradient(6) + stylesize("100%","95%") ]) link([ :url = website, :title = "back" , :style = stylecolor("white")]) newline() divstart([ :style= styledivcenter("500","130") + stylegradient(52) ]) formpost("ex29.ring") tablestart([ :Style = stylemarginleft("2%") + stylemargintop("2%") + stylewidth("90%") ]) rowstart([]) cellstart([:style = stylewidth("20%") + styleheight(30)]) text("User Name") cellend() cellstart([ :style = stylewidth("80%") ]) textbox([:name = "username", :style = stylewidth("100%")]) cellend() 45.21. Users registration and Login 336
- 360. Ring Documentation, Release1.4.1 rowend() rowstart([]) cellstart([ :style = styleheight(30)]) text("Password") cellend() cellstart([]) textbox([:name = "password" , :type = "password"]) cellend() rowend() rowstart([]) cellstart([ :style = styleheight(30) ]) cellend() cellstart([]) submit([:value = "Login" ]) cellend() rowend() tableend() formend() divend() divend() } Screen Shot: The response page #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" Import System.Web 45.21. Users registration and Login 337
- 361. Ring Documentation, Release1.4.1 oUser = new UsersModel oUser.Connect() lResult = oUser.FindWith("username",aPageVars["username"]) new page { if lResult if sha256(aPagevars["password"]+oUser.Salt) = oUser.pwhash text ("Correct Password!") aPageVars["sessionid"] = str2hex(randbytes(32)) oUser.UpdateColumn("sessionid",aPageVars["sessionid"]) cookie("sessionid",aPageVars["sessionid"]) else text ("Bad password!") ok else text("Bad User Name!") ok } oUser.Disconnect() The next code for checking if the user needs to login or not #!c:ringbinring.exe -cgi Load "weblib.ring" Load "datalib.ring" Load "ex25_users.ring" Import System.Web oUser = new UsersModel oUser.Connect() lResult = oUser.FindWith("sessionid",aPageVars["sessionid"]) new page { if lResult text("User Name : " + oUser.username ) else text("Please Login First!") ok } oUser.Disconnect() 45.22 Database, ModelBase & ControllerBase classes In this section we will see some code from datalib.ring The next code presents the Database, ModelBase & ControllerBase classes Import System.Web Class Database cServer = "localhost" cUserName = "root" cPassword = "root" cDatabase = "mahdb" Func Connect 45.22. Database, ModelBase & ControllerBase classes 338
- 362. Ring Documentation, Release1.4.1 con = mysql_init() mysql_connect(con, cServer, cUserName, cPassWord,cDatabase) Func Disconnect mysql_close(con) Func Query cQuery mysql_query(con,cQuery) Func QueryResult return mysql_result(con) Func QueryResultWithColumns # return columns names + query result return mysql_result2(con) Func QueryValue aResult = mysql_result(con) if islist(aResult) and len(aResult) >= 1 aResult = aResult[1] if len(aResult) >= 1 return aResult[1] ok ok return 0 Func EscapeString x if isstring(x) return MySQL_Escape_String(con,x) else return MySQL_Escape_String(con,string(x)) ok Private con = NULL Class ModelBase from Database cTableName = "" cSearchColumn = "name" aColumns = [] aQueryResult = [] ID = 0 # set table name from class name classname = lower(classname(self)) if right(classname,5) = :model cTablename = left(classname,len(classname)-5) ok Func Insert cValues = "" for x in aColumns cValues += "'" + EscapeString(aPageVars[x]) + "'," 45.22. Database, ModelBase & ControllerBase classes 339
- 363. Ring Documentation, Release1.4.1 Next cValues = left(cValues,len(cValues)-1) # remove last comma cColumns = "" for x in aColumns cColumns += x + "," next cColumns = left(cColumns,len(cColumns)-1) query("insert into " + cTableName + "("+cColumns+") values (" + cValues + ")" ) Func Update nID cStr = "" for x in aColumns cStr += x + " = '" + EscapeString(aPageVars[x]) + "' , " # the space after comma is necessary Next cStr = left(cStr,len(cStr)-2) query("update " + cTableName + " set " + cStr + " where id = " + nID ) Func UpdateColumn cColumn,cValue query("update " + cTableName + " set " + cColumn + " = '" + EscapeString(cValue) + "' where id = " + self.ID ) Func Count cValue query("SELECT count(*) FROM " + cTableName + " where "+cSearchColumn+" like '" + EscapeString(cValue) + "%'") return queryValue() Func Read nStart,nRecordsPerPage query("SELECT * FROM "+ cTableName+" limit " + EscapeString(nStart) + "," + EscapeString(nRecordsPerPage) ) aQueryResult = queryResult() Func Search cValue,nStart,nRecordsPerPage query("SELECT * FROM "+ cTableName+" where "+cSearchColumn+" like '" + EscapeString(cValue) + "%'" + " limit " + EscapeString(nStart) + "," + EscapeString(nRecordsPerPage) ) aQueryResult = queryResult() Func Find nID query("select * from " + cTableName + " where id = " + EscapeString(nID) ) aResult = queryResult()[1] # move the result from the array to the object attributes ID = nID cCode = "" for x = 2 to len(aResult) cCode += aColumns[x-1] + " = hex2str('" + str2hex(aResult[x]) + "')" + nl next eval(cCode) Func FindWith cColumn,cValue 45.22. Database, ModelBase & ControllerBase classes 340
- 364. Ring Documentation, Release1.4.1 query("select * from " + cTableName + " where "+cColumn+" = '" + EscapeString(cValue) + "'" ) aResult = queryResult() if len(aResult) > 0 aResult = aResult[1] else return 0 ok # move the result from the array to the object attributes ID = aResult[1] cCode = "" for x = 2 to len(aResult) cCode += aColumns[x-1] + " = hex2str('" + str2hex(aResult[x]) + "')" + nl next eval(cCode) return 1 Func Delete ID query("delete from " + cTableName + " where id = " + EscapeString(ID) ) Func Clear cCode = "" for x in aColumns cCode += x + ' = ""' + nl next eval(cCode) Func LoadModel # create the columns array query("SELECT * FROM "+ cTableName + " limit 0,1") aQueryResult = QueryResultWithColumns()[1] for x = 2 to len(aQueryResult) aColumns + lower(trim(aQueryResult[x])) next # create attribute for each column for x in aColumns addattribute(self,x) next Func Connect Super.Connect() if nLoadModel = 0 nLoadModel = 1 LoadModel() ok private nLoadModel = 0 Class ControllerBase 45.22. Database, ModelBase & ControllerBase classes 341
- 365. Ring Documentation, Release1.4.1 nRecordsPerPage = 5 nRecordsCount = 0 nPagesCount = 0 nActivePage = 0 # Dynamic creation of oView = new tablenameView and oModel = new tablename.Model classname = lower(classname(self)) if right(classname,10) = :controller tablename = left(classname,len(classname)-10) cCode = "oView = new " + tablename+"View" + nl cCode += "oModel = new " + tablename+"Model" + nl eval(cCode) oModel.connect() ok cSearchName = "searchname" cPart = "part" cPageError = "The page number is not correct" cLast = "last" cOperation = "operation" cRecID = "recid" aColumnsNames = ["id"] for t in oModel.aColumns aColumnsNames + t next cMainURL = website + "?" func Routing switch aPageVars[cOperation] on NULL showtable() on :add addrecord() on :save saverecord() on :delete deleterecord() on :edit editrecord() on :update updaterecord() off func ShowTable nRecordsCount = oModel.Count( aPageVars[cSearchName] ) nPagesCount = ceil(nRecordsCount / nRecordsPerPage) if aPageVars[cPart] = cLast aPageVars[cPart] = string(nPagesCount) ok nActivePage = number(aPageVars[cPart]) if nActivePage = 0 nActivePage = 1 ok if ( nActivePage > nPagesCount ) and nRecordsCount > 0 ErrorMsg(cPageError) return ok 45.22. Database, ModelBase & ControllerBase classes 342
- 366. Ring Documentation, Release1.4.1 nStart = (nActivePage-1)*nRecordsPerPage if aPageVars[cSearchName] = NULL oModel.Read( nStart,nRecordsPerPage ) else oModel.Search( aPageVars[cSearchName],nStart,nRecordsPerPage ) ok oView.GridView(self) func AddRecord oModel.clear() oView.FormViewAdd(Self,:save,false) # false mean don't include record id func SaveRecord oModel.Insert() oView.SaveView(self) func EditRecord oModel.Find( aPageVars[cRecID] ) oView.FormViewEdit(Self,:update,true) # true mean include record id func UpdateRecord oModel.update( aPageVars[cRecID] ) oView.UpdateView(self) func DeleteRecord oModel.Delete( aPageVars[cRecID] ) oView.DeleteView() func braceend oModel.Disconnect() 45.23 WebLib API In this section we will see the web library functions, classes and methods. Function Parameters Description LoadVars None Save the request parameters and cookies to aPageVars List WebPage None Create new object from the WebPage Class BootStrapWebPage None Create new object from the BootStrapWebPage Class HTMLSpecialChars cString Encode Special characters to HTML equivalent Template cFile,oObject Execute Ring Code in cFile after accessing oObject using {} Alert cMessage Generate HTML Web Page that display cMessage using JavaScript Alert() HTML2PDF cString Generate and Display PDF File from HTML String (cString) The Package System.Web contains the next classes 45.23. WebLib API 343
- 367. Ring Documentation, Release1.4.1 Class Name Description Application Contains methods for Encoding, Decoding, Cookies & More. Page Contains methods to generate HTML pages. ScriptFunctions Contains methods to generate some JavaScript Functions. StyleFunctions Contains methods to generate CSS. PageBuffer Generate HTML Page in memory (don’t print the output). HTML2PDF Generate PDF File from HTML code. BootStrapPage Using BootStrap Library. WebPage Generate page using objects for each element. BootStrapWebPage Generate page using objects, using BootStrap Library. ObjsBase Parent Class for page objects. NewObjectsFunctions Methods to create new objects in the page or element. H1 Wraps HTML H1. H2 Wraps HTML H2. H3 Wraps HTML H3. H4 Wraps HTML H4. H5 Wraps HTML H5. H6 Wraps HTML H6. P Wraps HTML P. Link Wraps HTML link. NewLine Wraps HTML NewLine. Div Wraps HTML Div. Form Wraps HTML Form. Input Wraps HTML Input. TextArea Wraps HTML TextArea. Select Wraps HTML Select. Option Wraps HTML Option. Image Wraps HTML Image. UL Wraps HTML UL. LI Wraps HTML LI. Table Wraps HTML Table. TR Wraps HTML TR. TD Wraps HTML TD. TH Wraps HTML TH. Audio Wraps HTML Audio. Video Wraps HTML Video. Nav Wraps HTML Nav. Span Wraps HTML Span. Button Wraps HTML Button. 45.23. WebLib API 344
- 368. Ring Documentation, Release1.4.1 45.24 Application Class Method Parameters Description DecodeString cString Decode request parameters Decode cString Decode multipart/form-data GetFileName aArray,cVar Get File Name in aArray using cVar SetCookie name,value,expires,path,domain,secure Set Cookie Cookie name,value Set Cookie using name and value only GetCookies None Get Cookies URLEncode cString URL Encode ScriptLibs None Add JavaScript Libraries like BootStrap Print None Print Page Content Style cStyle Add cStyle to page CSS content StartHTML None Add HTTP Header to page content The method DecodeString is used to get HTTP request parameters. The methods Decode and GetFileName are used for uploading files. The methods SetCookie, Cookie & GetCookies are used for adding and reading cookies. The methods StartHTML, ScriptsLibs, Style & Print are used for page structure and JS/CSS support. The method URLEncode is used to encode a URL to be used in HTML pages. 45.25 Page Class Method Parameters Description text x add HTMLSpecialChars(x) to page content (accept strings and numbers) html cString add html code to page content h1 x add x to page content between <h1> and </h1> h2 x add x to page content between <h2> and </h2> h3 x add x to page content between <h3> and </h3> h4 x add x to page content between <h4> and </h4> h5 x add x to page content between <h5> and </h5> h6 x add x to page content between <h6> and </h6> p aPara HTML <p> </p>, uses aPara List as Hash to get attributes NewLine None add <br /> to page content AddAttributes aPara Convert aPara list as hash to HTML element attributes Link aPara HTML <a href> and </a>, uses aPara List as Hash to get attributes Image aPara HTML <img>, uses aPara List as Hash to get attributes Button aPara HTML <input type=”button”>, uses aPara List as Hash to get attributes ButtonLink aPara HTML <input type=”button”>, uses link attribute to navigate to link Textbox aPara HTML <input type=”text”>, uses aPara List as Hash to get attributes Editbox aPara HTML <textarea> and </textarea>, uses aPara to get attributes Combobox aPara HTML <select>, uses items attribute as list for <option> Listbox aPara HTML <select multiple=’multiple’>, uses items attribute for <option> ulstart aPara HTML <ul> ulend aPara HTML </ul> listart aPara HTML <li> liend aPara HTML </li> Continued on next page 45.24. Application Class 345
- 369. Ring Documentation, Release1.4.1 Table 45.2 – continued from previous page Method Parameters Description List2UL aList Generate HTML <ul> including items from Ring List items DivStart aPara HTML <div>, uses aPara List as Hash to get attributes NavStart aPara HTML <nav>, uses aPara List as Hash to get attributes SpanStart aPara HTML <span>, uses aPara List as Hash to get attributes BoxStart None Generate Div with black background to be used as page header DivEnd None HTML </div> NavEnd None HTML </nav> SpanEnd None HTML </span> BoxEnd None HTML </div>, the same as divend() FormStart cAction HTML <form>, with cAction as the action attribute or an empty value FormPost cAction HTML <form method=”post”> , with cAction as the action attribute FormEnd None HTML </form> Submit aPara HTML <input type=”submit”> Hidden cName,cValue HTML <input type=”hidden”> FormUpload x HTML Form, method=”post” enctype=”multipart/form-data” and x = action UploadFile x HTML <input type=”file”> and name = x Video aPara HTML <video> Audio aPara HTML <audio> GetColor aPara Select Color Radio aPara HTML <input type=”radio”> Checkbox aPara HTML <input type=”checkbox”> Spinner aPara HTML <input type=”number”> Slider aPara HTML <input type=”range”> TableStart aPara HTML <table> TableEnd None HTML </table> RowStart aPara HTML <tr> RowEnd None HTML </tr> CellStart aPara HTML <td> CellEnd None HTML </td> HeaderStart aPara HTML <th> HeaderEnd None HTML </th> aPara in the page methods is a list contains attributes and values. Using aPara we can set values for the next attributes classname id name align style dir value onclick oncontextmenu ondblclick onmousedown onmouseenter onmouseleave onmousemove onmouseover onmouseout onmouseup onkeydown onkeypress onkeyup onabort onbeforeunload onerror onhashchange onload onpageshow onpagehide onresize onscroll onunload onblur onchange onfocus onfocusin onfocusout oninput oninvalid onreset onsearch onselect onsubmit ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop oncopy oncut onpaste onafterprint onbeforeprint oncanplay oncanplaythrough ondurationchange onemptied onended onloadeddata onloadedmetadata onloadstart onpause onplay onplaying onprogress onratechange onseeked onseeking onstalled onsuspend ontimeupdate onvolumechange onwaiting animationend animationiteration animationstart transitionend onmessage onopen onmousewheel ononline onoffline onpostate onshow onstorage ontoggle onwheel ontouchcancel ontouchend ontouchmove ontouchstart color opacity background backgroundattachment backgroundcolor backgroundimage backgroundposition backgroundrepeat backgroundclip backgroundorigin backgroundsize border borderbottom borderbottomcolor borderbottomleftradius borderbottomrightradius borderbottomstyle borderbottomwidth bordercolor borderimage borderimageoutset borderimagerepeat borderimageslice 45.25. Page Class 346
- 370. Ring Documentation, Release1.4.1 borderimagesource borderimagewidth borderleft borderleftcolor borderleftstyle borderleftwidth borderradius borderright borderrightcolor borderrightstyle borderrightwidth borderstyle bordertop bordertopcolor bordertopleftradius bordertoprightradius bordertopstyle bordertopwidth borderwidth boxdecorationbreak boxshadow bottom clear clip display float height left margin marginbottom marginleft marginright margintop maxheight maxwidth minheight minwidth overflow overflowx overflowy padding paddingbottom paddingleft paddingright paddingtop position right top visibility width verticalalign zindex aligncontent alignitems alignself flex flexbasis flexdirection flexflow flexgrow flexshrink flexwrap justifycontent order hangingpunctuation hyphens letterspacing linebreak lineheight overflowwrap tabsize textalign textalignlast textcombineupright textindent textjustify texttransform whitespace wordbreak wordspacing wordwrap textdecoration textdecorationcolor textdecorationline textdecorationstyle textshadow textunderlineposition @fontface @fontfeaturevalues font fontfamily fontfeaturesettings fontkerning fontlanguageoverride fontsize fontsizeadjust fontstretch fontstyle fontsynthesis fontvariant fontvariantalternates fontvariantcaps fontvarianteastasian fontvariantligatures fontvariantnumeric fontvariantposition fontweight direction textorientation unicodebidi writingmode bordercollapse borderspacing captionside emptycells tablelayout counterincrement counterreset liststyle liststyleimage liststyleposition liststyletype @keyframes animation animationdelay animationdirection animationduration animationfillmode animationiterationcount animationname animationplaystate animationtimingfunction backfacevisibility perspective perspectiveorigin transform transformorigin transformstyle transition transitionproperty transitionduration transitiontimingfunction transitiondelay boxsizing content cursor imemode navdown navindex navleft navright navup outline outlinecolor outlineoffset outlinestyle outlinewidth resize textoverflow breakafter breakbefore breakinside columncount columnfill columngap columnrule columnrulecolor columnrulestyle columnrulewidth columnspan columnwidth columns widows orphans pagebreakafter pagebreakbefore pagebreakinside marks quotes filter imageorientation imagerendering imageresolution objectfit objectposition mask masktype mark markafter markbefore phonemes rest restafter restbefore voicebalance voiceduration voicepitch voicepitchrange voicerate voicestress voicevolume marqueedirection marqueeplaycount marqueespeed marqueestyle datatoggle dataride datatarget dataslideto dataslide datadismiss dataplacement datacontent datatrigger dataspy dataoffset dataoffsettop 45.26 ScriptFunctions Class This class contains methods for adding JavaScript code to the generated web page. The class methods are merged to the Page class, so we can use the next methods with page objects directly. Method Parameters Description Script cCode Add cCode string between <script> and </script> ScriptRedirec- tion cURL set window.location to cURL ScriptFunc cFuncName,cCode Define function cFuncName that contains cCode ScriptFuncAlert cFuncName,cMsg Define function cFuncName that uses alert() to print cMsg ScriptFuncAjax cFuncName,cLink,cDiv Define function cFuncName that load cLink in cDiv ScriptFuncClean cFuncName,cDiv Define function cFuncName that clear the cDiv ScriptFuncSe- lect cF,aL,cD,cR,cGR,cFC,nTO,cL1,cL2 Used to Edit/Delete Grid Record ScriptScroll- Fixed cDiv,nSize Set cDiv as Fixed Div with Size = nSize 45.26. ScriptFunctions Class 347
- 371. Ring Documentation, Release1.4.1 45.27 StyleFunctions Class This class contains methods for adding CSS to the generated web page. Like ScriptFunctions Class, The StyleFunctions class methods are merged to the Page class, so we can use the next methods with page objects directly. Method Parameters Description StyleFloatLeft None Return float: left ; StyleFloatRight None Return float: right ; StyleSizeFull None Return width: 100% ; height: 100% ; Stylecolor x Return ” color: ” + x + ” ; “ Stylebackcolor x Return ” background-color: ” + x + ” ;” StyleTextCenter None Return “text-align: center ;” StyleTextRight None Return “text-align: right ;” StyleTextLeft None Return “text-align: left ;” StyleSize x,y Return ” width: ” + x + ” ; height: ” + y + ” ;” StyleWidth x Return ” width: ” + x + ” ;” StyleHeight x Return ” height: ” + x + ” ;” StyleTop x Return ” top: ” + x + ” ;” StyleLeft x Return ” Left: ” + x + ” ;” StylePos x,y Return ” top: ” + x + ” ;” + ” Left: ” + y + ” ;” StyleHorizontalCenter None Return ” margin-right:auto ; margin-left:auto; “ StyleMarginTop x Return ” margin-top: ” + x + ” ;” StyleMarginRight x Return ” margin-right: ” + x + ” ;” StyleMarginLeft x Return ” margin-left: ” + x + ” ;” StyleDivCenter nWidth,nHeight Create Div in the center of the page StyleAbsolute None Return ” position:absolute ;” StyleFixed None Return ” position:fixed ;” StyleZIndex x Return ” z-index: ” + x + ” ;” StyleFontSize x Return ” font-size: ” + x + ” ;” StyleGradient x Generate Gradient (x values from 1 to 60) StyleTable None Set table properties StyleTableRows id Set different color to even and odd rows in the table StyleTableNoBorder None Return ” border-style: none;” 45.27. StyleFunctions Class 348
- 372. CHAPTER FORTYSIX USING RINGLIBCURL In thischapter we will learn about using RingLibCurl 46.1 Get Request Example: load "libcurl.ring" curl = curl_easy_init() curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1) curl_easy_setopt(curl, CURLOPT_URL, "http://ring-lang.sf.net") curl_easy_perform(curl) curl_easy_cleanup(curl) 46.2 Post Request Example: load "libcurl.ring" curl = curl_easy_init() cPostThis = "page=4&Number1=4&Number2=5" curl_easy_setopt(curl, CURLOPT_URL, "http://localhost/ringapp/index.ring?page=3") curl_easy_setopt(curl, CURLOPT_POSTFIELDS, cPostThis) curl_easy_perform(curl) curl_easy_cleanup(curl) 46.3 Facebook Login Example: 349
- 373. Ring Documentation, Release1.4.1 load "libcurl.ring" see "Enter Email : " give $login_email See "Enter Password : " give $login_pass curl = curl_easy_init() curl_easy_setopt(curl, CURLOPT_URL, 'https://www.facebook.com/login.php') curl_easy_setopt(curl, CURLOPT_POSTFIELDS,'charset_test=j u s t a t e s t'+ ' &email='+urlencode($login_email)+'&pass='+ urlencode($login_pass)+'&login=Login') curl_easy_setopt(curl, CURLOPT_POST, 1) curl_easy_setopt(curl, CURLOPT_HEADER, 0) curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1) curl_easy_setopt(curl, CURLOPT_COOKIEJAR, "cookies.txt") curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "cookies.txt") curl_easy_setopt(curl, CURLOPT_USERAGENT, "Mozilla/5.0 (Windows; U;"+ " Windows NT 5.1; en-US; rv:1.8.1.3) Gecko/20070309 Firefox/2.0.0.3") curl_easy_setopt(curl, CURLOPT_REFERER, "http://www.facebook.com") curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, FALSE) curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2) mylist = curl_slist_append(NULL,'Accept-Charset: utf-8') curl_slist_append(mylist,'Accept-Language: en-us,en;q=0.7,bn-bd;q=0.3') curl_slist_append(mylist,'Accept: text/xml,application/xml,'+ 'application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5') curl_easy_setopt(curl, CURLOPT_HTTPHEADER, mylist) curl_easy_setopt(curl, CURLOPT_COOKIESESSION, false) curl_easy_perform(curl) curl_easy_cleanup(curl) Func URLEncode cStr cOut = "" for x in cStr if isalnum(x) cOut += x but x = " " cOut += "+" else cOut += "%"+str2hex(x) ok next return cOut 46.4 Save Output to String Example: load "libcurl.ring" curl = curl_easy_init() curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1) 46.4. Save Output to String 350
- 374. Ring Documentation, Release1.4.1 curl_easy_setopt(curl, CURLOPT_URL, "http://ring-lang.sf.net") cOutput = curl_easy_perform_silent(curl) See "Output:" + nl see cOutput curl_easy_cleanup(curl) Get Stock Data From Yahoo —-===================== Example: Load "libcurl.ring" ### Part 1 --- Get Crumb and Cookie ----------------------------------------- See "Start curl_easy_init(): "+ nl curl = curl_easy_init() ### >>> HANDLE >>> 01006BD0 CURL 0 curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1) curl_easy_setopt(curl, CURLOPT_COOKIEJAR, "cookies.txt") curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "cookies.txt") curl_easy_setopt(curl, CURLOPT_URL, "https://finance.yahoo.com/quote/AMZN/history") ### HTML Data >>> STDOUT Window, Use curl_easy_perform_silent >>> String cOutput = curl_easy_perform_silent(curl) ### GO Get Data >>> String ### Extract Crumb from data ### "CrumbStore":{"crumb":"abcdefghijk"}, if cOutput != NULL newStr1 = substr(cOutput, substr(cOutput, '"CrumbStore":{"crumb":"' ), 48 ) nPosS = substr(newStr1, ':"' ) ; ### Start of crumb -2 nPosE = substr(newStr1, '"}' ) ; ### End of crumb nCount = nPosE - nPosS -2 ### size of crumb myCrumb = substr(newStr1, nPosS +2, nCount) See "myCrumb.: |"+ myCrumb +"|" +nl ### UniCode "u002F" replace it with "/" if substr( myCrumb, "u002F") myCrumb = substr( myCrumb, "u002F", "/") See "myCrumb2: |"+ myCrumb +"|"+ nl ok else See "No Connectivity to Yahoo. Looking for Cookie and Crumb." +nl +nl ok ### Part 2 --- Send URL with Crumb, and Cookie ----------------------------------------- ### Send URL+Crumb to Yahoo to fetch 1st stock history data, $url = "https://query1.finance.yahoo.com/v7/finance/download/AMZN?period1=1277856000&period2= 46.4. Save Output to String 351
- 375. Ring Documentation, Release1.4.1 curl_easy_setopt(curl, CURLOPT_URL, $url); cStr = curl_easy_perform_silent(curl) See cStr curl_easy_cleanup(curl) ### REMEMBER to CLOSE CURL Output: myCrumb.: |sEEeW97mxvN| Date,Open,High,Low,Close,Adj Close,Volume 2010-07-05,110.650002,117.480003,109.000000,117.260002,117.260002,21000400 2010-07-12,117.809998,124.879997,117.320000,118.489998,118.489998,29407300 2010-07-19,118.379997,121.250000,105.800003,118.870003,118.870003,74252100 46.4. Save Output to String 352
- 376. CHAPTER FORTYSEVEN USING RINGZIP In thischapter we will learn about using RingZip 47.1 Create Zip File Example : Create myfile.zip contains 4 files load "ziplib.ring" oZip = zip_openfile("myfile.zip",'w') zip_addfile(oZip,"test.c") zip_addfile(oZip,"zip.c") zip_addfile(oZip,"zip.h") zip_addfile(oZip,"miniz.h") zip_close(oZip) 47.2 Extract Zip File Example : Extract myfile.zip to myfolder folder. load "ziplib.ring" zip_extract_allfiles("myfile.zip","myfolder") 47.3 Print Files in Zip file Example : Print file names in the myfile.zip load "ziplib.ring" oZip = zip_openfile("myfile.zip",'r') for x=1 to zip_filescount(oZip) see zip_getfilenamebyindex(oZip,x) + nl next zip_close(oZip) 47.4 Using RingZip Classes The RingZip library comes with two classes. The Zip class and the ZipEntry class. 353
- 377. Ring Documentation, Release1.4.1 Example (1): load "ziplib.ring" new Zip { setFileName("myfile.zip") open("w") newEntry() { open("test.c") writefile("test.c") close() } close() } Example (2): load "ziplib.ring" new Zip { SetFileName("myfile.zip") Open("w") AddFile("test.c") AddFile("zip.c") AddFile("zip.h") AddFile("miniz.h") Close() } Example (3): load "ziplib.ring" new zip { SetFileName("myfile.zip") ExtractAllFiles("myfolder") } Example (4): load "ziplib.ring" new Zip { SetFileName("myfile.zip") Open("r") see FilesCount() Close() } Example (5): load "ziplib.ring" new Zip { SetFileName("myfile.zip") Open("r") for x = 1 to filescount() See GetFileNameByIndex(x) + nl next Close() 47.4. Using RingZip Classes 354
- 378. Ring Documentation, Release1.4.1 } 47.5 Zip Class Reference Methods: Method Description/Output SetFileName(cName) Set the Zip file name GetFileName() Return the Zip file name Open(cMode) Open File, cMode = “a”, “w” or “r” Close() Close the Zip File AddFile(cFileName) Add file to the Zip file ExtractAllFiles(cFolder) Extract all files from the Zip file FilesCount() Return files count in the Zip file GetFileNameByIndex(nIndex) Return file name in the Zip file by file index NewEntry() Create new ZipEntry object 47.6 ZipEntry Class Reference Methods: Method Description/Output Open(cFileName) Open new Entry WriteFile(cFileName) Write File to the Entry WriteString(cString) Write String to the Entry Close() Close the Entry 47.5. Zip Class Reference 355
- 379. CHAPTER FORTYEIGHT GRAPHICS AND 2DGAMES PROGRAMMING USING RINGALLEGRO In this chapter we will learn how to use the allegro game programming library in our Ring applications. We have the file gamelib.ring that load the DLL library that contains wrappers for the Allegro functions Load "allegro.rh" Loadlib("ring_allegro.dll") The file gamelib.ring uses the Load instruction to execute the file allegro.rh which is a ring source code file con- tains constants to be used in our programs. Then using the function LoadLib() we can load the DLL library “ring_allegro.dll”. To write portable code we can change the gamelib.ring to check the platform before loading the DLL/So file. 48.1 Drawing, Animation and Input The next example uses the Allegro library for drawing, moving objects on the screen and getting input from the keyboard and the mouse. Load "gamelib.ring" al_init() al_init_image_addon() display = al_create_display(640,480) al_show_native_message_box(display, "Hello", "Welcome", "Using Allegro from the Ring programming language", "", 0); al_clear_to_color(al_map_rgb(0,0,255)) BOUNCER_SIZE = 40 bouncer_x = 10 bouncer_y = 20 bouncer = al_create_bitmap(BOUNCER_SIZE, BOUNCER_SIZE) al_set_target_bitmap(bouncer) al_clear_to_color(al_map_rgb(255,0,255)) for x = 1 to 30 bouncer_x += x bouncer_y += x al_set_target_bitmap(al_get_backbuffer(display)) al_clear_to_color(al_map_rgb(0,0,0)) 356
- 380. Ring Documentation, Release1.4.1 al_draw_bitmap(bouncer, bouncer_x, bouncer_y, 0) al_draw_bitmap(bouncer, 200+bouncer_x,200+ bouncer_y, 0) al_flip_display() al_rest(0.1) next al_clear_to_color(al_map_rgb(255,255,255)) image = al_load_bitmap("man2.jpg") al_draw_bitmap(image,200,200,0) al_flip_display() al_rest(2) event_queue = al_create_event_queue() al_register_event_source(event_queue, al_get_display_event_source(display)) ev = al_new_allegro_event() timeout = al_new_allegro_timeout() al_init_timeout(timeout, 0.06) FPS = 60 timer = al_create_timer(1.0 / FPS) al_register_event_source(event_queue, al_get_timer_event_source(timer)) al_start_timer(timer) redraw = true SCREEN_W = 640 SCREEN_H = 480 BOUNCER_SIZE = 32 bouncer_x = SCREEN_W / 2.0 - BOUNCER_SIZE / 2.0 bouncer_y = SCREEN_H / 2.0 - BOUNCER_SIZE / 2.0 bouncer_dx = -4.0 bouncer_dy = 4.0 al_install_mouse() al_register_event_source(event_queue, al_get_mouse_event_source()) al_install_keyboard() al_register_event_source(event_queue, al_get_keyboard_event_source()) KEY_UP = 1 KEY_DOWN = 2 KEY_LEFT = 3 KEY_RIGHT = 4 Key = [false,false,false,false] while true al_wait_for_event_until(event_queue, ev, timeout) switch al_get_allegro_event_type(ev) on ALLEGRO_EVENT_DISPLAY_CLOSE exit on ALLEGRO_EVENT_TIMER # Animation if bouncer_x < 0 or bouncer_x > SCREEN_W - BOUNCER_SIZE bouncer_dx = -bouncer_dx ok if bouncer_y < 0 or bouncer_y > SCREEN_H - BOUNCER_SIZE 48.1. Drawing, Animation and Input 357
- 381. Ring Documentation, Release1.4.1 bouncer_dy = -bouncer_dy ok bouncer_x += bouncer_dx bouncer_y += bouncer_dy # Keyboard if key[KEY_UP] and bouncer_y >= 4.0 bouncer_y -= 4.0 ok if key[KEY_DOWN] and bouncer_y <= SCREEN_H - BOUNCER_SIZE - 4.0 bouncer_y += 4.0 ok if key[KEY_LEFT] and bouncer_x >= 4.0 bouncer_x -= 4.0 ok if key[KEY_RIGHT] and bouncer_x <= SCREEN_W - BOUNCER_SIZE - 4.0 bouncer_x += 4.0 ok redraw = true on ALLEGRO_EVENT_MOUSE_AXES bouncer_x = al_get_allegro_event_mouse_x(ev) bouncer_y = al_get_allegro_event_mouse_y(ev) on ALLEGRO_EVENT_MOUSE_ENTER_DISPLAY bouncer_x = al_get_allegro_event_mouse_x(ev) bouncer_y = al_get_allegro_event_mouse_y(ev) on ALLEGRO_EVENT_MOUSE_BUTTON_UP exit on ALLEGRO_EVENT_KEY_DOWN switch al_get_allegro_event_keyboard_keycode(ev) on ALLEGRO_KEY_UP key[KEY_UP] = true on ALLEGRO_KEY_DOWN key[KEY_DOWN] = true on ALLEGRO_KEY_LEFT key[KEY_LEFT] = true on ALLEGRO_KEY_RIGHT key[KEY_RIGHT] = true off on ALLEGRO_EVENT_KEY_UP switch al_get_allegro_event_keyboard_keycode(ev) on ALLEGRO_KEY_UP key[KEY_UP] = false on ALLEGRO_KEY_DOWN key[KEY_DOWN] = false on ALLEGRO_KEY_LEFT key[KEY_LEFT] = false on ALLEGRO_KEY_RIGHT key[KEY_RIGHT] = false on ALLEGRO_KEY_ESCAPE exit off off if redraw and al_is_event_queue_empty(event_queue) redraw = false al_clear_to_color(al_map_rgb(0,0,0)) 48.1. Drawing, Animation and Input 358
- 382. Ring Documentation, Release1.4.1 al_draw_bitmap(bouncer, bouncer_x, bouncer_y, 0) al_flip_display() ok callgc() end al_destroy_timer(timer) al_destroy_allegro_event(ev) al_destroy_allegro_timeout(timeout) al_destroy_event_queue(event_queue) al_destroy_bitmap(bouncer) al_destroy_bitmap(image) al_destroy_display(display) Note: In the previous example we used the function callgc() which is a Ring function to force calling the Garbage collector inside the While/End loop. Program Output: At first the program display a messagebox Then we see two rectangles are moving on the screen 48.1. Drawing, Animation and Input 359
- 383. Ring Documentation, Release1.4.1 Then we see an image displayed on the screen 48.1. Drawing, Animation and Input 360
- 384. Ring Documentation, Release1.4.1 Finally we have one rectangle, and we see it moving all of the time on the screen but we can control it using the Mouse and/or the Keyborad 48.1. Drawing, Animation and Input 361
- 385. Ring Documentation, Release1.4.1 48.2 Using TrueType Fonts In this example we will see how to use TrueType Fonts *.ttf in our Games using Allegro Load "gamelib.ring" al_init() al_init_font_addon() al_init_ttf_addon() display = al_create_display(800,600) al_clear_to_color(al_map_rgb(0,0,255)) font = al_load_ttf_font("pirulen.ttf",14,0 ) al_draw_text(font, al_map_rgb(255,255,255), 10, 10,ALLEGRO_ALIGN_LEFT, "Welcome to the Ring programming language") al_flip_display() al_rest(2) al_destroy_display(display) Screen Shot: 48.2. Using TrueType Fonts 362
- 386. Ring Documentation, Release1.4.1 48.3 Playing Sound Files The next example play a sound file Load "gamelib.ring" al_init() al_install_audio() al_init_acodec_addon() al_reserve_samples(1) sample = al_load_sample( "footstep.wav" ) sampleid = al_new_allegro_sample_id() al_play_sample(sample, 1.0, 0.0,1.0,ALLEGRO_PLAYMODE_LOOP,sampleid) display = al_create_display(640,480) al_clear_to_color(al_map_rgb(0,0,255)) al_flip_display() al_rest(10) al_destroy_allegro_sample_id(sampleid) 48.3. Playing Sound Files 363
- 387. Ring Documentation, Release1.4.1 al_destroy_sample(sample) al_destroy_display(display) al_exit() 48.4 Scaling and Rotating Images The next example display and rotate an image Load "gamelib.ring" al_init() al_init_image_addon() display = al_create_display(640,480) al_set_target_bitmap(al_get_backbuffer(display)) al_clear_to_color(al_map_rgb(255,255,255)) image = al_load_bitmap("man2.jpg") al_draw_rotated_bitmap(image,0,0,250,250,150,0) al_draw_scaled_bitmap(image,0,0,250,250,20,20,400,400,0) al_flip_display() al_rest(2) al_destroy_bitmap(image) al_destroy_display(display) Screen Shot: 48.4. Scaling and Rotating Images 364
- 388. Ring Documentation, Release1.4.1 48.5 Display Transparent Image The next example display image with white background on another image Load "gamelib.ring" al_init() al_init_image_addon() display = al_create_display(640,480) imageback = al_load_bitmap("palace.jpg") al_draw_bitmap(imageback,0,0,0) image = al_load_bitmap("man4.png") al_convert_mask_to_alpha(image,al_map_rgb(255,255,255)) al_draw_bitmap(image,0,0,0) al_flip_display() al_rest(10) al_destroy_bitmap(image) al_destroy_display(display) 48.5. Display Transparent Image 365
- 389. Ring Documentation, Release1.4.1 Screen Shot: 48.6 Using Threads In this example we will learn how to use threads from the Allegro library Load "gamelib.ring" o1 = new mythreads Func Main al_init() for k = 1 to 5 al_create_thread("o1.thread1()") al_create_thread("o1.thread2()") al_create_thread("o1.thread3()") next al_rest(2) Class Mythreads cAppName = "Threads Application" 48.6. Using Threads 366
- 390. Ring Documentation, Release1.4.1 Func Thread1 for x = 1 to 5 see x + nl next See 'Thread(1) : Application Name : ' + cAppName + nl Func Thread2 for x = 1 to 5 see '*****' + x + nl next See 'Thread(2) : Application Name : ' + cAppName + nl Func Thread3 for x = 1 to 5 see '!!!!' + x + nl next See 'Thread(3) : Application Name : ' + cAppName + nl Output: 1 2 3 4 5 Thread(1) : Application Name : Threads Application *****1 *****2 *****3 *****4 *****5 Thread(2) : Application Name : Threads Application !!!!1 !!!!2 !!!!3 !!!!4 !!!!5 Thread(3) : Application Name : Threads Application 1 2 3 4 5 Thread(1) : Application Name : Threads Application !!!!1 !!!!2 !!!!3 !!!!4 !!!!5 Thread(3) : Application Name : Threads Application *****1 *****2 *****3 *****4 *****5 Thread(2) : Application Name : Threads Application *****1 *****2 48.6. Using Threads 367
- 391. Ring Documentation, Release1.4.1 *****3 *****4 *****5 Thread(2) : Application Name : Threads Application !!!!1 !!!!2 !!!!3 !!!!4 !!!!5 Thread(3) : Application Name : Threads Application 1 2 3 4 5 Thread(1) : Application Name : Threads Application *****1 *****2 *****3 *****1 *****4 *****2 !!!!1 *****5 *****3 1 !!!!2 Thread(2) : Application Name : Threads Application 1 *****4 !!!!1 2 !!!!3 !!!!4 *****5 !!!!2 3 2 !!!!5 Thread(2) : Application Name : Threads Application !!!!3 4 3 Thread(3) : Application Name : Threads Application !!!!4 5 4 !!!!5 Thread(1) : Application Name : Threads Application 5 Thread(3) : Application Name : Threads Application Thread(1) : Application Name : Threads Application 48.6. Using Threads 368
- 392. CHAPTER FORTYNINE USING RINGLIBSDL In thischapter we will learn about using RingLibSDL to create games based on the LibSDL, SDLImage, SDLTTF and SDLMixer libraries. Tip: RingLibSDL is not distributed with the binary releases for desktop which uses RingAllegro Note: To use RingLibSDL, Check ring/android/ringlibsdl folder. 49.1 Create Window Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) SDL_Delay(2000) SDL_DestroyWindow(win) SDL_Quit() 49.2 Display Image Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) ren = SDL_CreateRenderer(win, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC ) bmp = SDL_LoadBMP("hello.bmp") tex = SDL_CreateTextureFromSurface(ren,bmp) SDL_FreeSurface(bmp) SDL_RenderClear(ren) SDL_RenderCopy2(ren,tex) SDL_RenderPresent(ren) SDL_Delay(2000) SDL_DestroyTexture(tex) SDL_DestroyRenderer(ren) SDL_DestroyWindow(win) SDL_Quit() 369
- 393. Ring Documentation, Release1.4.1 49.3 Switch between two images Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) ren = SDL_CreateRenderer(win, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC ) bmp = SDL_LoadBMP("hello.bmp") tex = SDL_CreateTextureFromSurface(ren,bmp) SDL_FreeSurface(bmp) bmp = SDL_LoadBMP("hello2.bmp") tex2 = SDL_CreateTextureFromSurface(ren,bmp) SDL_FreeSurface(bmp) for x = 1 to 10 showtex(tex) showtex(tex2) next SDL_DestroyTexture(tex) SDL_DestroyTexture(tex2) SDL_DestroyRenderer(ren) SDL_DestroyWindow(win) SDL_Quit() func showtex oTex SDL_RenderClear(ren) SDL_RenderCopy2(ren,oTex) SDL_RenderPresent(ren) SDL_Delay(200) 49.4 Draw Rectangle Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) ren = SDL_CreateRenderer(win, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC ) SDL_RenderClear(ren) rect = sdl_new_sdl_rect() sdl_set_sdl_rect_x(rect,10) sdl_set_sdl_rect_y(rect,10) sdl_set_sdl_rect_w(rect,100) sdl_set_sdl_rect_h(rect,100) SDL_SetRenderDrawColor(ren,255,255,255,255) SDL_RenderDrawRect(ren,rect) sdl_destroy_sdl_rect(rect) SDL_RenderPresent(ren) SDL_Delay(2000) SDL_DestroyRenderer(ren) SDL_DestroyWindow(win) SDL_Quit() 49.3. Switch between two images 370
- 394. Ring Documentation, Release1.4.1 49.5 Display PNG Images Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) ren = SDL_CreateRenderer(win, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC ) bmp = IMG_Load("hello3.png") tex = SDL_CreateTextureFromSurface(ren,bmp) SDL_FreeSurface(bmp) SDL_RenderClear(ren) SDL_RenderCopy2(ren,tex) SDL_RenderPresent(ren) SDL_Delay(2000) SDL_DestroyTexture(tex) SDL_DestroyRenderer(ren) SDL_DestroyWindow(win) SDL_Quit() 49.6 Use TTF Fonts Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) ren = SDL_CreateRenderer(win, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC ) SDL_RenderClear(ren) TTF_Init() font = TTF_OpenFont("pirulen.ttf", 16) color = sdl_new_sdl_color() sdl_set_sdl_color_r(color,0) sdl_set_sdl_color_g(color,255) sdl_set_sdl_color_b(color,0) text = TTF_RenderText_Solid(font,"Welcome to the Ring language",color) surface = SDL_GetWindowSurface(win) SDL_BlitSurface(text, nullpointer(), surface, nullpointer()) SDL_UpdateWindowSurface(win) SDL_Delay(2000) SDL_Destroy_SDL_Color(color) SDL_FreeSurface(text) TTF_CloseFont(font) SDL_DestroyRenderer(ren) SDL_DestroyWindow(win) SDL_Quit() 49.7 Display Transparent Images Example: 49.5. Display PNG Images 371
- 395. Ring Documentation, Release1.4.1 Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) flags = IMG_INIT_JPG | IMG_INIT_PNG IMG_Init(flags) win = SDL_CreateWindow("Hello World!", 100, 100, 800, 600, SDL_WINDOW_SHOWN) ren = SDL_CreateRenderer(win, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC ) bmp = IMG_Load("stars.jpg") tex = SDL_CreateTextureFromSurface(ren,bmp) SDL_FreeSurface(bmp) SDL_RenderClear(ren) SDL_RenderCopy(ren,tex,nullpointer(),nullpointer()) SDL_DestroyTexture(tex) bmp = IMG_Load("player.png") # Image - Set Transparent color (white) myformat = sdl_get_sdl_surface_format(bmp) white = SDL_MapRGB(myformat, 255, 255, 255) SDL_SetColorKey(bmp, SDL_True, white) tex = SDL_CreateTextureFromSurface(ren,bmp) SDL_FreeSurface(bmp) rect = sdl_new_sdl_rect() sdl_set_sdl_rect_x(rect,0) sdl_set_sdl_rect_y(rect,0) sdl_set_sdl_rect_w(rect,100) sdl_set_sdl_rect_h(rect,100) SDL_RenderCopy(ren,tex,nullpointer(),rect) SDL_SetTextureBlendMode(tex,2) SDL_SetTextureAlphaMod(tex,255) sdl_set_sdl_rect_x(rect,200) sdl_set_sdl_rect_y(rect,200) sdl_set_sdl_rect_w(rect,100) sdl_set_sdl_rect_h(rect,100) SDL_RenderCopy(ren,tex,nullpointer(),rect) SDL_DestroyTexture(tex) SDL_Destroy_SDL_Rect(rect) SDL_RenderPresent(ren) SDL_Delay(2000) SDL_DestroyRenderer(ren) SDL_DestroyWindow(win) SDL_Quit() 49.8 Close Window Event Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) 49.8. Close Window Event 372
- 396. Ring Documentation, Release1.4.1 win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) myevent = sdl_new_sdl_event() while true thevent = sdl_pollevent(myevent) switch sdl_get_sdl_event_type(myevent) on sdl_get_sdl_quit() exit on sdl_get_sdl_keydown() Key = SDL_GET_SDL_Event_key_keysym_sym(myevent) if key = 27 exit ok off end SDL_DestroyWindow(win) SDL_Quit() 49.9 Mouse Events Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Mouse Events ", 100, 100, 640, 480, SDL_WINDOW_SHOWN) TTF_Init() font = TTF_OpenFont("pirulen.ttf", 16) color = sdl_new_sdl_color() sdl_set_sdl_color_r(color,0) sdl_set_sdl_color_g(color,255) sdl_set_sdl_color_b(color,0) surface = SDL_GetWindowSurface(win) myevent = sdl_new_sdl_event() while true cMsg = "" sdl_pollevent(myevent) switch sdl_get_sdl_event_type(myevent) on SDL_QUIT exit on SDL_KEYDOWN Key = SDL_GET_SDL_Event_key_keysym_sym(myevent) if key = 27 exit ok on SDL_MOUSEBUTTONDOWN if sdl_get_Sdl_Event_button_button(myevent) = SDL_BUTTON_LEFT SDL_SETWINDOWTITLE(win, " Button_Left_Down " ) but sdl_get_Sdl_Event_button_button(myevent) = SDL_BUTTON_MIDDLE SDL_SETWINDOWTITLE(win, " Button_Middle_Down " ) but sdl_get_Sdl_Event_button_button(myevent) = SDL_BUTTON_RIGHT SDL_SETWINDOWTITLE(win, " Button_Right_Down " ) ok on SDL_MOUSEMOTION 49.9. Mouse Events 373
- 397. Ring Documentation, Release1.4.1 sdl_fillrect(surface,nullpointer(),0) if sdl_get_sdl_event_motion_xrel(myevent) < 0 cMsg += " Left " else cMsg += " Right " ok if sdl_get_sdl_event_motion_yrel(myevent) < 0 cMsg += " Up " else cMsg += " Down " ok cMsg += " x = " + sdl_get_sdl_event_motion_x(myevent) cMsg += " y = " + sdl_get_sdl_event_motion_y(myevent) showmsg(cMsg) off end SDL_Destroy_SDL_Color(Color) TTF_CloseFont(font) SDL_DestroyWindow(win) SDL_Quit() func showmsg mymsg text = TTF_RenderText_Solid(font,mymsg,color) SDL_BlitSurface(text, nullpointer(), surface, nullpointer()) SDL_UpdateWindowSurface(win) SDL_FreeSurface(text) 49.10 Play Sound Example: Load "libsdl.ring" SDL_Init(SDL_INIT_EVERYTHING) win = SDL_CreateWindow("Hello World!", 100, 100, 640, 480, SDL_WINDOW_SHOWN) Mix_OpenAudio( 44100, MIX_DEFAULT_FORMAT , 2, 10000) Mix_AllocateChannels(4) sound = Mix_LoadWav( "sound.wav" ) Mix_VolumeChunk(sound,1) Mix_PlayChannel(1,sound,0) myevent = sdl_new_sdl_event() while true thevent = sdl_pollevent(myevent) switch sdl_get_sdl_event_type(myevent) on sdl_get_sdl_quit() exit on sdl_get_sdl_keydown() Key = SDL_GET_SDL_Event_key_keysym_sym(myevent) if key = 27 exit ok off end Mix_FreeChunk( sound ) Mix_CloseAudio() 49.10. Play Sound 374
- 398. Ring Documentation, Release1.4.1 Mix_Quit() SDL_DestroyWindow(win) SDL_Quit() 49.10. Play Sound 375
- 399. CHAPTER FIFTY DEMO PROJECT -GAME ENGINE FOR 2D GAMES In this chapter we will learn about using the different programming paradigms in the same project. We will create a simple Game Engine for 2D Games. You can use the Engine directly to create 2D Games for Desktop or Mobile. 50.1 Project Layers The project contains the next layers • Games Layer (Here we will use declarative programming) • Game Engine Classes (Here we will use the Object-Oriented Programming paradigm) • Interface to graphics library (Here we will use procedural programming) • Graphics Library bindings (Here we have RingAllegro and RingLibSDL) 50.2 Graphics Library bindings We already have RingAllegro to use the Allegro game programming library and we have RingLibSDL to use the LibSDL game programming library. Both of RingAllegro and RingLibSDL are created using the C language with the help of the Ring code generator for extensions. Each of them is over 10,000 lines of C code which is generated after writing simple configuration files (That are processed by the code generator). Each configuration file determines the functions names, structures information and constants then the generator process this configuration file to produce the C code and the library that can be loaded from Ring code. Using RingAllegro and RingLibSDL is very similar to using Allegro and LibSDL from C code where you have the same functions but we can build on that using the Ring language features • RingAllegro Source Code : https://github.com/ring-lang/ring/tree/master/extensions/ringallegro • RingLibSDL Source Code : https://github.com/ring-lang/ring/tree/master/extensions/ringsdl 376
- 400. Ring Documentation, Release1.4.1 50.3 Interface to graphics library In this layer we have gl_allegro.ring and gl_libsdl.ring Each library provides the same functions to be used with interacting with the Graphics Library. This layer hides the details and the difference between RingAllegro and RingLibSDL. You have the same functions, Just use it and you can switch between Allegro and LibSDL at anytime. Why ? Allegro is very simple, we can use it to quickly create 2D games for Windows, Linux and MacOS X. In Ring 1.0 we started by supporting Allegro. Also LibSDL is very powerful and popular, very easy to use for Mobile Development. Ring 1.1 comes with support for LibSDL so we can quickly create games for Mobile. Note: We can use just one library for Desktop and Mobile development. • gl_allegro.ring source code : https://github.com/ring-lang/ring/blob/master/ringlibs/gameengine/gl_allegro.ring • gl_libsdl.ring source code : https://github.com/ring-lang/ring/blob/master/ringlibs/gameengine/gl_libsdl.ring 50.4 Game Engine Classes The Engine comes with the next classes • GameBase class • Resources class • Game class • GameObject class • Sprite class • Text class • Animate class • Sound class • Map class • Source Code : https://github.com/ring-lang/ring/blob/master/ringlibs/gameengine/gameengine.ring 50.5 Games Layer In this layer we create our games using the Game Engine classes The classes are designed to be used through Declarative Programming. In our games we will use the next classes • Game class • Sprite class 50.3. Interface to graphics library 377
- 401. Ring Documentation, Release1.4.1 • Text class • Animate class • Sound class • Map class Note: Other classes in the engine are for internal use by the engine. We will introduce some examples and three simple games :- • Stars Fighter Game • Flappy Bird 3000 Game • Super Man 2016 Game 50.6 Game Class The next table present the class attributes. Attributes Description FPS Number determines how many times the draw() method will be called per second. FixedFPS Number determines how many times the animate() method will be called per second. Title String determines the window title of the game. aObjects List contains all objects in the game shutdown True/False value to end the game loop The next table present the class methods. Method Description refresh() Delete objects. settitle(cTitle) Set the window title using a string parameter. shutdown() Close the application. The next table present a group of keywords defined by the class. Keyword Description sprite Create new Sprite object and add it to the game objects. text Create new Text object and add it to the game objects. animate Create new Animate object and add it to the game objects. sound Create new Sound object and add it to the game objects. map Create new Map object and add it ot the game objects. 50.7 GameObject Class The next table present the class attributes. 50.6. Game Class 378
- 402. Ring Documentation, Release1.4.1 Attributes Description enabled True/False determine the state of the object (Active/Not Active) x Number determine the x position of the object. y Number determine the y position of the object. width Number determine the width of the object. height Number determine the height of the object. nIndex Number determine the index of the object in objects list. animate True/False to animate the object or not. move True/False to move the object using the keyboard or not. Scaled True/False to scale the object image or not. draw Function to be called when drawing the object. state Function to be called for object animation. keypress Function to be called when a key is pressed. mouse Function to be called when a mouse event happens. The next table present the class methods. Method Description keyboard(oGame,nkey) Check Keyboard Events mouse(oGame,nType,aMouseList) Check Mouse Events rgb(r,g,b) Return new color using the RGB (Red, Green and Blue) Values. 50.8 Sprite Class Parent Class : GameObject Class The next table present the class attributes. Attributes Description image String determine the image file name. point Number determine the limit of automatic movement of the object. direction Number determine the direction of movement. nstep Number determine the increment/decrement during movement. type Number determine the object type in the game (Optional). transparent True/False value determine if the image is transparent. The next table present the class methods. Method Description Draw(oGame) Draw the object 50.9 Text Class Parent Class : Sprite Class The next table present the class attributes. Attributes Description size Number determine the font size font String determine the font file name text String determine the text to be displayed color Number determine the color The next table present the class methods. 50.8. Sprite Class 379
- 403. Ring Documentation, Release1.4.1 Method Description Draw(oGame) Draw the object 50.10 Animate Class Parent Class : Sprite Class The next table present the class attributes. Attributes Description frames Number determine the number of frames frame Number determine the active frame framewidth Number determine the frame width. animate True/False determine using animate or not. scaled True/False determine scaling image or not. The next table present the class methods. Method Description Draw(oGame) Draw the object 50.11 Sound Class Parent Class : GameObject Class The next table present the class attributes. Attributes Description file String determine the sound file name. once True/False determine to play the file one time or not (loop). The next table present the class methods. Method Description playsound() Play the sound file 50.12 Map Class Parent Class : Sprite Class The next table present the class attributes. Attributes Description aMap List determine the map content using numbers. aImages List determine the image used for each number in the map. BlockWidth Number determine the block width (default = 32). BlockHeight Number determine the block height (default = 32). Animate True/False determine the animation status. The next table present the class methods. Method Description getvalue(x,y) Return the item value in the Map according to the visible part 50.10. Animate Class 380
- 404. Ring Documentation, Release1.4.1 50.13 Using the Game Engine - Creating the Game Window Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" } # Start the Events Loop Note: if you want to define global variables, this must be before load “gameengine.ring” because this instruction will give the control to the game engine. Screen Shot: 50.14 Using the Game Engine - Drawing Text Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine 50.13. Using the Game Engine - Creating the Game Window 381
- 405. Ring Documentation, Release1.4.1 oGame = New Game # Create the Game Object { title = "My First Game" text { x = 10 y=50 animate = false size = 20 file = "fonts/pirulen.ttf" text = "game development using ring is very fun!" color = rgb(0,0,0) } } # Start the Events Loop Screen Shot: 50.15 Using the Game Engine - Moving Text Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine oGame = New Game # Create the Game Object 50.15. Using the Game Engine - Moving Text 382
- 406. Ring Documentation, Release1.4.1 { title = "My First Game" text { x = 10 y=50 animate = false size = 20 file = "fonts/pirulen.ttf" text = "game development using ring is very fun!" color = rgb(0,0,0) # Color = black } text { x = 10 y=150 # Animation Part ===================================== animate = true # Use Animation direction = GE_DIRECTION_INCVERTICAL # Increase y point = 400 # Continue until y=400 nStep = 3 # Each time y+= 3 #===================================================== size = 20 file = "fonts/pirulen.ttf" text = "welcome to the real world!" color = rgb(0,0,255) # Color = Blue } } # Start the Events Loop Screen Shot: 50.15. Using the Game Engine - Moving Text 383
- 407. Ring Documentation, Release1.4.1 50.16 Using the Game Engine - Playing Sound Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" text { x = 10 y=50 animate = false size = 20 file = "fonts/pirulen.ttf" text = "game development using ring is very fun!" color = rgb(0,0,0) # Color = black } text { x = 10 y=150 # Animation Part ====================================== animate = true # Use Animation direction = GE_DIRECTION_INCVERTICAL # Increase y 50.16. Using the Game Engine - Playing Sound 384
- 408. Ring Documentation, Release1.4.1 point = 400 # Continue until y=400 nStep = 3 # Each time y+= 3 #====================================================== size = 20 file = "fonts/pirulen.ttf" text = "welcome to the real world!" color = rgb(0,0,255) # Color = Blue } Sound { # Play Sound file = "sound/music1.wav" # Sound File Name } } # Start the Events Loop 50.17 Using the Game Engine - Animation Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" animate { file = "images/fire.png" x = 100 y = 200 framewidth = 40 height = 42 nStep = 3 # Used for delay transparent = true state = func oGame,oSelf { # Called by engine each frame oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 13 # we have 13 frames in animation frame++ # move to next frame else oGame.remove(oself.nIndex) # remove object ok ok } } } } # Start the Events Loop 50.17. Using the Game Engine - Animation 385
- 409. Ring Documentation, Release1.4.1 50.18 Using the Game Engine - Animation and Functions Load "gameengine.ring" # Give Control to the Game Engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" for x = 70 to 700 step 50 for y = 70 to 500 step 50 showfire(oGame,x,y) next next } # Start the Events Loop func showfire oGame,nX,nY oGame { animate { file = "images/fire.png" x = nX 50.18. Using the Game Engine - Animation and Functions 386
- 410. Ring Documentation, Release1.4.1 y = nY framewidth = 40 height = 42 nStep = 3 # Used for delay transparent = true state = func oGame,oSelf { # Called by engine each frame oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 13 # we have 13 frames in animation frame++ # move to next frame else frame=1 ok ok } } } } 50.18. Using the Game Engine - Animation and Functions 387
- 411. Ring Documentation, Release1.4.1 50.19 Using the Game Engine - Sprite - Automatic Movement using Keyboard Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" sprite { type = GE_TYPE_PLAYER # Just for our usage x=400 y=400 width=100 height=100 file = "images/player.png" transparent = true Animate=false Move=true # we can move it using keyboard arrows Scaled=true } } # Start the Events Loop 50.19. Using the Game Engine - Sprite - Automatic Movement using Keyboard 388
- 412. Ring Documentation, Release1.4.1 50.20 Using the Game Engine - Sprite - Keypress event Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" sprite { type = GE_TYPE_PLAYER # Just for our usage x=400 y=400 width=100 height=100 file = "images/player.png" transparent = true Animate=false Move=false # Custom Movement Scaled=true keypress = func oGame,oSelf,nKey { oSelf { Switch nKey on KEY_LEFT x -= 10 on KEY_RIGHT x += 10 on KEY_UP y -= 10 on KEY_DOWN y += 10 off } } } } # Start the Events Loop 50.21 Using the Game Engine - Sprite - Mouse event Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" sprite { type = GE_TYPE_PLAYER # Just for our usage x=400 y=400 width=100 height=100 file = "images/player.png" transparent = true Animate=false Move=false # Custom Movement Scaled=true keypress = func oGame,oSelf,nKey { oSelf { 50.20. Using the Game Engine - Sprite - Keypress event 389
- 413. Ring Documentation, Release1.4.1 Switch nKey on KEY_LEFT x -= 10 on KEY_RIGHT x += 10 on KEY_UP y -= 10 on KEY_DOWN y += 10 off } } mouse = func oGame,oSelf,nType,aMouseList { if nType = GE_MOUSE_UP oSelf { x = aMouseList[GE_MOUSE_X] y = aMouseList[GE_MOUSE_Y] } ok } } } # Start the Events Loop 50.22 Using the Game Engine - Sprite - State event Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" sprite { type = GE_TYPE_PLAYER # Just for our usage x=400 y=400 width=100 height=100 file = "images/player.png" transparent = true Animate=false Move=false # Custom Movement Scaled=true keypress = func oGame,oSelf,nKey { oSelf { Switch nKey on KEY_LEFT x -= 10 on KEY_RIGHT x += 10 on KEY_UP y -= 10 on KEY_DOWN y += 10 off } } mouse = func oGame,oSelf,nType,aMouseList { 50.22. Using the Game Engine - Sprite - State event 390
- 414. Ring Documentation, Release1.4.1 if nType = GE_MOUSE_UP oSelf { x = aMouseList[GE_MOUSE_X] y = aMouseList[GE_MOUSE_Y] } ok } state = func oGame,oSelf { oself { if x < 0 x = 0 ok if y < 0 y = 0 ok if x > ogame.width-width x= ogame.width - width ok if y > ogame.height-height y=ogame.height - height ok } } } } # Start the Events Loop 50.23 Using the Game Engine - Animate - Events Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" animate { file = "images/fbbird.png" x = 10 y = 10 framewidth = 20 scaled = true height = 50 width = 50 nStep = 3 transparent = true state = func oGame,oSelf { oSelf { # Animation nStep-- if nStep = 0 nStep = 3 if frame < 3 frame++ else frame=1 ok ok 50.23. Using the Game Engine - Animate - Events 391
- 415. Ring Documentation, Release1.4.1 # Move Down y += 3 if y > 550 y=550 ok } } keypress = func ogame,oself,nKey { oself { if nkey = key_space y -= 55 if y<=0 y=0 ok ok } } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP cFunc = oself.keypress call cFunc(oGame,oSelf,Key_Space) ok } } } # Start the Events Loop Screen Shot: 50.23. Using the Game Engine - Animate - Events 392
- 416. Ring Documentation, Release1.4.1 50.24 Using the Game Engine - Map Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,1,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], 50.24. Using the Game Engine - Map 393
- 417. Ring Documentation, Release1.4.1 [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0] ] aImages = ["images/fbwall.png", "images/fbwallup.png", "images/fbwalldown.png"] state = func oGame,oSelf { oSelf { x -= 3 if x < - 2100 x = 0 ok } } } } # Start the Events Loop Screen Shot: 50.24. Using the Game Engine - Map 394
- 418. Ring Documentation, Release1.4.1 50.25 Using the Game Engine - Map Events Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,1,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0] ] aImages = ["images/fbwall.png", "images/fbwallup.png", "images/fbwalldown.png"] state = func oGame,oSelf { oSelf { x -= 3 if x < - 2100 x = 0 ok } } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP oSelf { mX = aMouseList[GE_MOUSE_X] mY = aMouseList[GE_MOUSE_Y] nValue = GetValue(mX,mY) nRow = GetRow(mX,mY) nCol = GetCol(mX,mY) Switch nValue On 1 aMap[nRow][nCol] = 0 On 2 aMap[nRow][nCol] = 0 On 3 aMap[nRow][nCol] = 0 On 0 aMap[nRow][nCol] = 1 Off } ok } } } # Start the Events Loop 50.25. Using the Game Engine - Map Events 395
- 419. Ring Documentation, Release1.4.1 Screen Shot: 50.26 Using the Game Engine - Object and Drawing We can use the Object keyword (defined by the game engine) to create objects from the GameObject class. Example: Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" Object { x = 0 y=300 width = 200 height=200 draw = func oGame,oSelf { oSelf { for t = 1 to 210 gl_draw_circle(x,y,t, gl_map_rgb(t*random(255), t*2,t*3),1) 50.26. Using the Game Engine - Object and Drawing 396
- 420. Ring Documentation, Release1.4.1 next } } state = func oGame,oSelf { oSelf { if x <= 800 x+= 3 else x=0 ok } } keypress = func oGame,oSelf,nKey { oSelf { Switch nKey on KEY_LEFT x -= 10 on KEY_RIGHT x += 10 on KEY_UP y -= 10 on KEY_DOWN y += 10 off } } } } # Start the Events Loop Screen Shot: 50.26. Using the Game Engine - Object and Drawing 397
- 421. Ring Documentation, Release1.4.1 Example: Load "gameengine.ring" # Give control to the game engine func main # Called by the Game Engine oGame = New Game # Create the Game Object { title = "My First Game" Object { x = 400 y=300 width = 200 height=200 draw = func oGame,oSelf { oSelf { for t = 1 to 210 gl_draw_rectangle(x+t,y+t, x+t*2,y+t*2, gl_map_rgb(t*random(255), t*2,t*3),1) gl_draw_rectangle(x+t*2,y+t*2, x-t*2,y-t*2, gl_map_rgb(t*random(255), t*2,t*3),1) next } } 50.26. Using the Game Engine - Object and Drawing 398
- 422. Ring Documentation, Release1.4.1 keypress = func oGame,oSelf,nKey { oSelf { Switch nKey on KEY_LEFT x -= 10 on KEY_RIGHT x += 10 on KEY_UP y -= 10 on KEY_DOWN y += 10 off } } } } # Start the Events Loop Screen Shot: 50.27 Stars Fighter Game The Stars Fighter source code 50.27. Stars Fighter Game 399
- 423. Ring Documentation, Release1.4.1 # The Ring Standard Library # Game Engine for 2D Games # 2016, Mahmoud Fayed <msfclipper@yahoo.com> oGameState = NULL load "gameengine.ring" func main oGame = New Game while true oGameState = new GameState oGame { title = "Stars Fighter!" sprite { file = "images/menu1.jpg" x = 0 y=0 width=800 height = 600 scaled = true animate = false keypress = func ogame,oself,nKey { if nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() but nKey = key_space oGameState.startplay=true ogame.shutdown=true ok } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP oGameState.startplay=true ogame.shutdown=true ok } } text { animate = false size = 35 file = "fonts/pirulen.ttf" text = "Stars Fighter" x = 10 y=50 } text { animate = false size = 25 file = "fonts/pirulen.ttf" text = "Version 1.0" x = 80 y=100 } text { animate = false size = 16 file = "fonts/pirulen.ttf" text = "(C) 2016, Mahmoud Fayed" x = 45 y=140 } 50.27. Stars Fighter Game 400
- 424. Ring Documentation, Release1.4.1 text { animate = false size = 25 file = "fonts/pirulen.ttf" text = "Press Space to start" x = 190 y=470 } text { animate = false size = 20 file = "fonts/pirulen.ttf" text = "Press Esc to Exit" x = 260 y=510 } Sound { file = "sound/music1.wav" } } if oGameState.startplay oGame.refresh() playstart(oGame) oGame.refresh() ok end func playstart oGame oSound = New Sound { file = "sound/music2.wav" } while true play(oGame) if ogame.shutdown = true and oGameState.value = 0 exit ok ogame.refresh() end oSound.Delete() func play oGame oGame { FPS = 60 FixedFPS = 120 title = "Stars Fighter!" sprite { file = "images/stars.jpg" x = 0 y = 0 point = -370 direction = ge_direction_dec type = ge_type_background 50.27. Stars Fighter Game 401
- 425. Ring Documentation, Release1.4.1 state = func ogame,oself { oself { if x < -350 direction = ge_direction_inc point = 370 but x = 0 and direction = ge_direction_inc direction = ge_direction_dec point = -370 ok } } } sprite { file = "images/player.png" transparent = true type = ge_type_player x = 400 y =400 width=100 height=100 animate=false move=true Scaled=true mouse = func ogame,oself,nType,aMouseList { if not ( aMouseList[GE_MOUSE_X] >= oSelf.x and aMouseList[GE_MOUSE_X] <= oSelf.x+oSelf.width and aMouseList[GE_MOUSE_Y] >= oself.y and aMouseList[GE_MOUSE_Y] <= oSelf.y+oSelf.height ) if nType = GE_MOUSE_DOWN if aMouseList[1] < oSelf.X # left oSelf.X -= 100 else oSelf.X += 100 ok if aMouseList[2] < oSelf.Y # up oSelf.Y -= 100 else oSelf.Y += 100 ok ok else if nType = GE_MOUSE_UP cFunc = oself.keypress call cFunc(oGame,oSelf,Key_Space) ok ok } keypress = func oGame,oself,nkey { if nkey = key_space ogame { sprite { type = ge_type_fire file = "images/rocket.png" transparent = true x = oself.x + 30 y = oself.y - 30 width = 30 height = 30 point = -30 50.27. Stars Fighter Game 402
- 426. Ring Documentation, Release1.4.1 nstep = 20 direction = ge_direction_decvertical state = func oGame,oSelf { for x in oGame.aObjects if x.type = ge_type_enemy if oself.x >= x.x and oself.y >= x.y and oself.x <= x.x + x.width and oself.y <= x.y + x.height showfire(oGame,x.x+40,x.y+40) ogame.remove(x.nindex) oGameState.score+=10 oGameState.enemies-- checkwin(oGame) exit ok ok next } } } but nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() ok } state = func oGame,oSelf { oself { if x < 0 x = 0 ok if y < 0 y = 0 ok if x > ogame.screen_w-width x= ogame.screen_w - width ok if y > ogame.screen_h-height y=ogame.screen_h-height ok } } } for g = 1 to oGameState.enemies sprite { type = ge_type_enemy file = "images/enemy.png" transparent = true x = g*random(50) y =g width=100 height=100 animate=true Scaled=true direction = ge_direction_random state = func oGame,oSelf { oself { if x < 0 x = 0 ok if y < 0 y = 0 ok if x > ogame.screen_w-width x= ogame.screen_w - width ok if y > ogame.screen_h-height y=ogame.screen_h-height ok } if random(100) = 1 ogame { sprite { type = ge_type_fire file = "images/rocket2.png" transparent = true x = oself.x + 30 y = oself.y + oself.height+ 30 width = 30 height = 30 50.27. Stars Fighter Game 403
- 427. Ring Documentation, Release1.4.1 point = ogame.screen_h+30 nstep = 10 direction = ge_direction_incvertical state = func oGame,oSelf { x = oGame.aObjects[oGameState.playerindex] if oself.x >= x.x and oself.y >= x.y and oself.x <= x.x + x.width and oself.y <= x.y + x.height if oGameState.value > 0 oGameState.value-=10 ok ogame.remove(oself.nindex) checkgameover(oGame) ok } } } ok } } next text { size = 30 file = "fonts/pirulen.ttf" text = "Destroy All Enemies!" nstep = 3 color = GE_COLOR_GREEN x = 100 y=50 direction = ge_direction_incvertical point = 500 } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Score : " + oGameState.score x = 500 y=10 state = func oGame,oSelf { oSelf { text = "Score : " + oGameState.score } } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Energy : " + oGameState.value x = 500 y=50 state = func oGame,oSelf { oSelf { text = "Energy : " + oGameState.value } } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Level : " + oGameState.level x = 500 y=90 } } 50.27. Stars Fighter Game 404
- 428. Ring Documentation, Release1.4.1 func checkwin ogame if oGameState.gameresult return ok if oGameState.enemies = 0 oGameState.gameresult = true oGame { if oGameState.level < 30 text { point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Level Completed!" nStep = 3 x = 500 y=10 state = func ogame,oself { if oself.y >= 400 ogame.shutdown = true oGameState.level++ oGameState.enemies = oGameState.level oGameState.gameresult = false ok } } else text { point = 400 size = 30 nStep = 3 file = "fonts/pirulen.ttf" text = "You Win !!!" x = 500 y=10 state = func ogame,oself { if oself.y >= 400 ogame.shutdown = true oGameState.value = 0 ok } } ok } ok func checkgameover ogame if oGameState.gameresult return ok if oGameState.value <= 0 oGameState.gameresult = true oGame { text { point = 400 size = 30 nStep = 3 file = "fonts/pirulen.ttf" text = "Game Over !!!" x = 500 y=10 state = func ogame,oself { if oself.y >= 400 ogame.shutdown = true ok 50.27. Stars Fighter Game 405
- 429. Ring Documentation, Release1.4.1 } } } showfire(oGame,oGame.aObjects[oGameState.PlayerIndex].x+40, oGame.aObjects[oGameState.PlayerIndex].y+40) oGame.aObjects[oGameState.PlayerIndex].enabled = false oGame.remove(oGameState.PlayerIndex) ok func showfire oGame,nX,nY oGame { animate { file = "images/fire.png" x = nX y = nY framewidth = 40 height = 42 nStep = 3 transparent = true state = func oGame,oSelf { oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 13 frame++ else frame=1 oGame.remove(oself.nIndex) ok ok } } } } class gamestate score = 0 level = 1 enemies = 1 value = 100 playerindex = 2 gameresult = false startplay=false Screen Shot: 50.27. Stars Fighter Game 406
- 430. Ring Documentation, Release1.4.1 50.28 Flappy Bird 3000 Game The Flappy Bird 3000 Game source code # The Ring Standard Library # Game Engine for 2D Games # 2016, Mahmoud Fayed <msfclipper@yahoo.com> oGameState = NULL Load "gameengine.ring" func main oGame = New Game while true oGameState = New GameState oGame { 50.28. Flappy Bird 3000 Game 407
- 431. Ring Documentation, Release1.4.1 title = "Flappy Bird 3000" sprite { file = "images/fbback.png" x = 0 y=0 width=800 height = 600 scaled = true animate = false keypress = func ogame,oself,nKey { if nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() but nKey = key_space oGameState.startplay=true ogame.shutdown=true ok } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP cFunc = oself.keypress call cFunc(oGame,oSelf,Key_Space) ok } } text { animate = false size = 35 file = "fonts/pirulen.ttf" text = "Flappy Bird 3000" x = 150 y=50 } text { animate = false size = 25 file = "fonts/pirulen.ttf" text = "Version 1.0" x = 280 y=100 } text { animate = false size = 16 file = "fonts/pirulen.ttf" text = "(C) 2016, Mahmoud Fayed" x = 245 y=140 } text { animate = false size = 25 file = "fonts/pirulen.ttf" text = "To Win Get Score = 3000" x = 150 y=270 } text { animate = false size = 25 file = "fonts/pirulen.ttf" text = "Press Space to start" x = 190 y=470 } text { 50.28. Flappy Bird 3000 Game 408
- 432. Ring Documentation, Release1.4.1 animate = false size = 20 file = "fonts/pirulen.ttf" text = "Press Esc to Exit" x = 260 y=510 } animate { file = "images/fbbird.png" x = 200 y = 200 framewidth = 20 scaled = true height = 50 width = 50 nStep = 3 transparent = true animate = true direction = ge_direction_random state = func oGame,oSelf { oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 3 frame++ else frame=1 ok ok if x <= 0 x=0 ok if y <= 0 y=0 ok if x >= 750 x= 750 ok if y > 550 y=550 ok } } } Sound { file = "sound/music2.wav" } } if oGameState.startplay oGame.refresh() playstart(oGame) oGame.refresh() ok end func playstart oGame oGame { FPS = 60 FixedFPS = 120 Title = "Flappy Bird 3000" Sprite { 50.28. Flappy Bird 3000 Game 409
- 433. Ring Documentation, Release1.4.1 file = "images/fbback.png" x = 0 y=0 width=800 height = 600 scaled = true animate = false keypress = func ogame,oself,nKey { if nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() ok } } Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,3,0,0,0,1,0,0,0,1,0,0,0], [0,0,0,0,0,0,0,0,0,3,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,3,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0] ] newmap(aMap) aImages = ["images/fbwall.png","images/fbwallup.png", "images/fbwalldown.png"] state = func oGame,oSelf { if oGameState.gameresult = false px = oGame.aObjects[3].x py = oGame.aObjects[3].y oSelf { x -= 3 if x < - 2100 x = 0 newmap(aMap) ok nCol = getcol(px,0) if nCol=11 or nCol=15 or nCol=19 or nCol=23 or nCol=27 if nCol != oGameState.lastcol oGameState.lastcol = nCol oGameState.Score += 100 oGame { Sound { once = true file = "sound/sfx_point.wav" } } checkwin(oGame) ok ok } if oSelf.getvalue(px+40,py) != 0 or oSelf.getvalue(px+40,py+40) != 0 or oSelf.getvalue(px,py) != 0 or oSelf.getvalue(px,py+40) != 0 oGameState.gameresult = true oGame { text { point = 550 size = 30 nStep = 3 50.28. Flappy Bird 3000 Game 410
- 434. Ring Documentation, Release1.4.1 file = "fonts/pirulen.ttf" text = "Game Over !!!" x = 500 y=10 state = func ogame,oself { if oself.y >= 550 ogame.shutdown = true ok if oself.y = 90 ogame { Sound { once = true file = "sound/sfx_die.wav" } } ok } } Sound { once = true file = "sound/sfx_hit.wav" } } ok ok } } animate { file = "images/fbbird.png" x = 10 y = 10 framewidth = 20 scaled = true height = 50 width = 50 nStep = 3 transparent = true state = func oGame,oSelf { oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 3 frame++ else frame=1 ok ok } if not oGameState.playerwin oGameState.down -- if oGameState.down = 0 oGameState.down = 3 oself { y += 25 if y > 550 y=550 ok } 50.28. Flappy Bird 3000 Game 411
- 435. Ring Documentation, Release1.4.1 ok ok } keypress = func ogame,oself,nKey { if oGameState.gameresult = false oself { if nkey = key_space y -= 55 oGameState.down = 60 if y<=0 y=0 ok ok } ok } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP cFunc = oself.keypress call cFunc(oGame,oSelf,Key_Space) ok } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Score : " + oGameState.score x = 500 y=10 state = func oGame,oSelf { oSelf { text = "Score : " + oGameState.score } } } } func newmap aMap aV = [ [1,1,3,0,0,2,1,1], [1,3,0,0,0,2,1,1], [1,1,1,3,0,2,1,1], [1,1,1,3,0,0,0,0], [0,0,0,0,2,1,1,1], [0,0,2,1,1,1,1,1], [0,0,0,2,1,1,1,1], [1,1,1,3,0,2,1,1], [1,1,1,1,1,3,0,0], [3,0,0,2,1,1,1,1], [3,0,0,2,3,0,0,2] ] for x = 10 to 24 step 4 aVar = aV[ (random(10)+1) ] for y = 1 to 8 aMap[y][x] = aVar[y] next next 50.28. Flappy Bird 3000 Game 412
- 436. Ring Documentation, Release1.4.1 func checkwin ogame if oGameState.score = 3000 oGameState.gameresult = true oGameState.playerwin = true oGame { text { point = 400 size = 30 nStep = 3 file = "fonts/pirulen.ttf" text = "You Win !!!" x = 500 y=10 state = func ogame,oself { if oself.y >= 400 ogame.shutdown = true oGameState.value = 0 ok } } } ok Class GameState down = 3 gameresult = false Score = 0 startplay=false lastcol = 0 playerwin = false Screen Shot: 50.28. Flappy Bird 3000 Game 413
- 437. Ring Documentation, Release1.4.1 50.29 Super Man 2016 Game The Super Man 2016 Game source code # The Ring Standard Library # Game Engine for 2D Games # 2016, Mahmoud Fayed <msfclipper@yahoo.com> oGameState = NULL Load "gameengine.ring" func main oGame = New Game while true oGameState = new GameState oGame { title = "Super Man 2016" 50.29. Super Man 2016 Game 414
- 438. Ring Documentation, Release1.4.1 sprite { file = "images/superman.jpg" x = 0 y=0 width=800 height = 600 scaled = true animate = false keypress = func ogame,oself,nKey { if nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() but nKey = key_space oGameState.startplay=true ogame.shutdown=true ok } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_UP oGameState.startplay=true ogame.shutdown=true ok } state = func ogame,oself { oself { if x > -500 x-=1 y-=1 width +=1 height +=4 ok } } } text { animate = false size = 35 file = "fonts/pirulen.ttf" text = "Super Man 2016" x = 20 y=30 } text { animate = false size = 25 file = "fonts/pirulen.ttf" text = "Version 1.0" x = 20 y=80 } text { animate = false size = 16 file = "fonts/pirulen.ttf" text = "(C) 2016, Mahmoud Fayed" x = 20 y=120 } text { animate = false size = 25 file = "fonts/pirulen.ttf" text = "Press Space to start" x = 190 y=470 } 50.29. Super Man 2016 Game 415
- 439. Ring Documentation, Release1.4.1 text { animate = false size = 20 file = "fonts/pirulen.ttf" text = "Press Esc to Exit" x = 260 y=510 } animate { file = "images/superman.png" x = 200 y = 200 framewidth = 68 scaled = true height = 86 width = 60 nStep = 10 transparent = true animate = true direction = ge_direction_random state = func oGame,oSelf { oSelf { nStep-- if nStep = 0 nStep = 10 if frame < 1 frame++ else frame=1 ok ok if x <= 0 x=0 ok if y <= 0 y=0 ok if x >= 750 x= 750 ok if y > 550 y=550 ok } } } Sound { file = "sound/music2.wav" } } if oGameState.startplay oGame.refresh() playstart(oGame) oGame.refresh() ok end func playstart oGame oGame { FPS = 60 FixedFPS = 15 Title = "Super Man 2016" 50.29. Super Man 2016 Game 416
- 440. Ring Documentation, Release1.4.1 Sprite { file = "images/supermancity.jpg" x = 0 y=0 width=800 height = 600 scaled = true animate = false } Map { blockwidth = 80 blockheight = 80 aMap = [ [0,0,0,4,4,4,0,0,0,1,0,0,0,1,4,4,0,1,0,0,0,0,4,4,0,1,4, 4,4,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,0,1,0,0,0,1,0,0,0,1,0,3,3,3,5,3,3,3,3,0], [0,0,4,0,4,0,4,0,0,1,0,0,0,3,4,4,4,1,0,0,0,0,4,4,0,1,4, 4,4,0,0,4,4,4,4,4,4,4,4,4,4,4,4,1,4,1,0,0,0,1,0,0,0,1,0,4,4,4,4,4,4,4,4,0], [0,0,0,4,4,4,0,0,0,1,0,0,0,4,4,4,4,1,0,0,0,0,0,0,0,3,4, 4,4,0,0,4,0,0,0,0,0,0,4,2,0,0,4,1,4,1,4,2,4,1,0,2,0,1,0,4,4,4,4,4,4,4,4,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0, 0,0,0,0,4,4,4,4,4,4,4,4,1,0,0,4,1,4,1,4,1,4,1,0,1,0,1,0,2,2,2,2,2,2,2,2,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0, 0,0,0,0,2,0,0,0,0,0,2,0,3,0,0,0,1,4,1,4,1,4,1,0,1,0,1,0,1,0,0,0,0,0,0,0,0], [0,0,0,0,0,0,0,0,0,1,0,0,0,2,0,0,0,1,0,0,0,2,0,0,0,0,0, 0,0,0,0,1,0,0,0,0,0,1,0,0,0,0,0,1,4,3,4,1,4,3,0,1,0,3,0,1,0,0,0,0,0,0,0,0], [0,0,2,0,0,2,0,0,2,1,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,0,0, 0,0,0,0,1,0,0,0,0,0,3,0,0,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,0,0,0,0,0], [0,0,1,0,0,1,0,0,1,3,0,0,0,1,0,0,0,3,0,0,0,1,0,0,0,0,0, 0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,1,0,0,0,0,0,0,0,0] ] aImages = ["images/smwall.png","images/smwallup.png", "images/smwalldown.png","images/smstar.png", "images/smkey.png","images/smstar2.png"] } sprite { type = ge_type_enemy animate = false file = "images/smhome.png" x = 5000 y = 400 width = 290 height = 200 transparent = true state = func oGame,oSelf { oself { x = 5000 + oGame.aObjects[2].x if x < 0 or x > SCREEN_W return ok } if oGameState.gameresult or oGameState.DoorKey = false return ok if oGame.aObjects[oGameState.playerindex].x > oself.x + 100 and oGame.aObjects[oGameState.playerindex].y > oself.y + 50 oGameState.gameresult = true oGame { sprite { file = "images/smwin.jpg" x=0 y=0 width=800 height=600 scaled = true animate=false state = func ogame,oself { oself { x-=5 y-=5 50.29. Super Man 2016 Game 417
- 441. Ring Documentation, Release1.4.1 width +=10 height +=10 if x = -300 ogame.shutdown = true ok } } } } ok } } animate { file = "images/superman.png" x = 0 y = 0 framewidth = 60 scaled = true height = 86 width = 60 nStep = 3 transparent = true state = func oGame,oSelf { checkstarskeycol(oGame,oSelf) if not oGameState.playerwin oself { file = "images/superman.png" height = 86 width = 60 for t=1 to 8 if checkwall2(oGame,oSelf,0,5,[2,1]) y += 5 else exit ok next if y > 500 y=500 ok } ok } keypress = func ogame,oself,nKey { if oGameState.gameresult = false oself { if nkey = key_up and checkwall(oGame,oSelf,0,-40) oGameState.value -= 1 checkgameover(oGame) file = "images/supermanup.png" height = 123 dotransparent() y -= 40 oGameState.down = 10 if y<=0 y=0 ok 50.29. Super Man 2016 Game 418
- 442. Ring Documentation, Release1.4.1 but nkey = key_down and checkwall(oGame,oSelf,0,40) file = "images/supermandown.png" dotransparent() y += 40 if y>=500 y=500 ok but nKey = key_right and checkwall(oGame,oSelf,10,0) file = "images/supermanright.png" dotransparent() x += 10 if x >= 440 if oGame.aObjects[2].x > -4500 oGame.aObjects[2].x -= 50 callenemystate(oGame) else if x <= 750 if checkwall(oGame,oSelf,10,0) x += 10 ok else if checkwall(oGame,oSelf,-10,0) x -= 10 ok ok return ok x=400 ok but nKey = key_left and checkwall(oGame,oSelf,-10,0) file = "images/supermanleft.png" dotransparent() x -= 10 if x <= 0 x += 10 if oGame.aObjects[2].x != 0 oGame.aObjects[2].x += 50 callenemystate(oGame) x += 50 ok ok but nkey = key_esc or nKey = GE_AC_BACK ogame.shutdown() ok } ok } mouse = func ogame,oself,nType,aMouseList { if nType = GE_MOUSE_DOWN oGameState.moveplayer = TRUE But nType = GE_MOUSE_UP oGameState.moveplayer = FALSE ok if oGameState.moveplayer = TRUE if aMouseList[GE_MOUSE_X] < oSelf.X # left cFunc = oself.keypress call cFunc(oGame,oSelf,Key_left) else cFunc = oself.keypress call cFunc(oGame,oSelf,Key_right) 50.29. Super Man 2016 Game 419
- 443. Ring Documentation, Release1.4.1 ok if aMouseList[GE_MOUSE_Y] < oSelf.Y # up cFunc = oself.keypress call cFunc(oGame,oSelf,Key_up) else cFunc = oself.keypress call cFunc(oGame,oSelf,Key_down) ok ok } } addenemy(oGame,600) addenemy(oGame,900) addenemy(oGame,1550) addenemy(oGame,2350) addenemy(oGame,3350) addenemy(oGame,3500) addenemy(oGame,3670) addenemy(oGame,3840) text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Score : " + oGameState.score x = 500 y=0 state = func oGame,oSelf { oSelf { text = "Score : " + oGameState.score } } } text { animate = false point = 400 size = 30 file = "fonts/pirulen.ttf" text = "Energy : " + oGameState.value x = 10 y=0 state = func oGame,oSelf { oSelf { text = "Energy : " + oGameState.value } } } } func inlist nValue,aList for x in aList if x = nValue return true ok next return false func checkwall oGame,oself,diffx,diffy alist = [1,2,3] return checkwall2(oGame,oself,diffx,diffy,aList) func checkwall2 oGame,oself,diffx,diffy,aList 50.29. Super Man 2016 Game 420
- 444. Ring Documentation, Release1.4.1 xPos = oSelf.x + diffx yPos = oSelf.y + diffy nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok xPos = oSelf.x + diffx yPos = oSelf.y + diffy + oSelf.height nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok xPos = oSelf.x + diffx + oSelf.width yPos = oSelf.y + diffy nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok xPos = oSelf.x + diffx + oSelf.width yPos = oSelf.y + diffy + oSelf.height nValue = oGame.aObjects[2].getvalue(xPos,yPos) nValue = inlist(nValue,aList) nValue = not nValue if nValue = 0 return nValue ok return nValue func checkopenwall oGame if oGameState.score = 900 oGame.aObjects[2].aMap[3][10] = 3 oGame.aObjects[2].aMap[4][10] = 0 oGame.aObjects[2].aMap[5][10] = 0 oGame.aObjects[2].aMap[6][10] = 0 oGame.aObjects[2].aMap[7][10] = 0 oGame.aObjects[2].aMap[8][10] = 0 but oGameState.score = 1800 oGame.aObjects[2].aMap[3][18] = 3 oGame.aObjects[2].aMap[4][18] = 0 oGame.aObjects[2].aMap[5][18] = 0 oGame.aObjects[2].aMap[6][18] = 0 oGame.aObjects[2].aMap[7][18] = 0 oGame.aObjects[2].aMap[8][18] = 0 but oGameState.score = 5500 oGame.aObjects[2].aMap[1][44] = 0 oGame.aObjects[2].aMap[2][44] = 0 oGame.aObjects[2].aMap[3][44] = 2 ok func checkgameover ogame if oGameState.gameresult return ok if oGameState.value <= 0 oGameState.value = 0 oGameState.gameresult = true oGame { 50.29. Super Man 2016 Game 421
- 445. Ring Documentation, Release1.4.1 text { point = 400 size = 30 nStep = 9 file = "fonts/pirulen.ttf" text = "Game Over !!!" x = 500 y=10 state = func ogame,oself { if oself.y >= 400 ogame.shutdown = true ok } } } showfire(oGame,oGame.aObjects[oGameState.PlayerIndex].x+40, oGame.aObjects[oGameState.PlayerIndex].y+40) oGame.aObjects[oGameState.PlayerIndex].enabled = false oGame.remove(oGameState.PlayerIndex) ok func showfire oGame,nX,nY oGame { animate { file = "images/fire.png" x = nX y = nY framewidth = 40 height = 42 nStep = 3 transparent = true state = func oGame,oSelf { oSelf { nStep-- if nStep = 0 nStep = 3 if frame < 13 frame++ else frame=1 oGame.remove(oself.nIndex) ok ok } } } } func addenemy oGame,xPos oGame { lbraceend = false sprite { type = ge_type_enemy file = "images/smenemy.png" transparent = true x = xPos y =10 width=100 height=100 animate=true Scaled=true direction = GE_DIRECTION_NOMOVE 50.29. Super Man 2016 Game 422
- 446. Ring Documentation, Release1.4.1 temp = xPos state = func oGame,oSelf { oself { x = oSelf.temp + oGame.aObjects[2].x if y < 0 y = 0 ok if y > 100 y=100 ok if x > SCREEN_W or x < 0 return ok } if random(10) = 1 if oGameState.gameresult return ok ogame { sprite { type = ge_type_fire file = "images/smrocket.png" scaled = true transparent = true x = oself.x + 30 y = oself.y + oself.height+ 30 width = 30 height = 30 point = ogame.screen_h+30 nstep = 30 direction = ge_direction_incvertical xvalue = oGame.aObjects[2].x temp = oself.x + 30 - xvalue state = func oGame,oSelf { oself { x = oSelf.temp + oGame.aObjects[2].x } x = oGame.aObjects[oGameState.playerindex] if oself.x >= x.x and oself.y >= x.y and oself.x <= x.x + x.width and oself.y <= x.y + x.height if oGameState.value > 0 oGameState.value-=1000 ok ogame.remove(oself.nindex) checkgameover(oGame) ok } } } ok } } } ogame.lbraceend = true func checkstarskey oGame,oSelf,nValue,nRow,nCol switch nValue on 4 oGame.aObjects[2].aMap[nRow][nCol] = 6 oGameState.Score += 100 checkopenwall(oGame) oGame { Sound { once = true file = "sound/sfx_point.wav" } } 50.29. Super Man 2016 Game 423
- 447. Ring Documentation, Release1.4.1 on 5 oGame.aObjects[2].aMap[nRow][nCol] = 0 oGameState.DoorKey = true oGameState.Score += 500 checkopenwall(oGame) oGame { Sound { once = true file = "sound/sfx_point.wav" } } off func checkstarskeycol oGame,oSelf nValue = oGame.aObjects[2].getvalue(oSelf.x,oSelf.y) nRow = oGame.aObjects[2].getrow(oSelf.x,oSelf.y) nCol = oGame.aObjects[2].getcol(oSelf.x,oSelf.y) checkstarskey(oGame,oSelf,nValue,nRow,nCol) nValue = oGame.aObjects[2].getvalue(oSelf.x+oSelf.width,oSelf.y+oSelf.height) nRow = oGame.aObjects[2].getrow(oSelf.x+oSelf.width,oSelf.y+oSelf.height) nCol = oGame.aObjects[2].getcol(oSelf.x+oSelf.width,oSelf.y+oSelf.height) checkstarskey(oGame,oSelf,nValue,nRow,nCol) nValue = oGame.aObjects[2].getvalue(oSelf.x+oSelf.width,oSelf.y) nRow = oGame.aObjects[2].getrow(oSelf.x+oSelf.width,oSelf.y) nCol = oGame.aObjects[2].getcol(oSelf.x+oSelf.width,oSelf.y) checkstarskey(oGame,oSelf,nValue,nRow,nCol) nValue = oGame.aObjects[2].getvalue(oSelf.x,oSelf.y+oSelf.height) nRow = oGame.aObjects[2].getrow(oSelf.x,oSelf.y+oSelf.height) nCol = oGame.aObjects[2].getcol(oSelf.x,oSelf.y+oSelf.height) checkstarskey(oGame,oSelf,nValue,nRow,nCol) func callenemystate oGame for t in oGame.aObjects t { if type = GE_TYPE_ENEMY call state(oGame,t) ok } next Class GameState down = 3 gameresult = false Score = 0 startplay=false lastcol = 0 playerwin = false DoorKey = false playerindex = 4 value = 1000 moveplayer = false Screen Shot: 50.29. Super Man 2016 Game 424
- 448. Ring Documentation, Release1.4.1 50.29. Super Man 2016 Game 425
- 449. CHAPTER FIFTYONE BUILDING GAMES FORANDROID In this chapter we will learn about Building RingLibSDL Games for Mobile. So we can create packages (*.apk) for the applications that are developed using Ring Game Engine for 2D Games. 51.1 Download Requirements and Update the Android SDK • The Android SDK Tools https://developer.android.com/studio/index.html • The Android NDK https://developer.android.com/ndk/index.html • Apache Ant v1.8 or later http://ant.apache.org/bindownload.cgi • Java SE Development Kit (JDK) v6 or later http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html • Update the Android SDK to get the API and tools packages required for development 51.2 Project Folder Open the project folder : ring/android/ringlibsdl/project 426
- 450. Ring Documentation, Release1.4.1 You can add the source code (*.ring) and Images/Sound Files to the assets folder. You will find the Flappy Bird 3000 Game ready for building. The execution starts from the start.ring file load "game2.ring" 51.3 Building the project Move to the ring/android/ringlibsdl/project folder We can build using the next command (We need to do this for one time only). ndk-build Then we can create the package (*.apk) using the next command. 51.3. Building the project 427
- 451. Ring Documentation, Release1.4.1 ant debug 51.3. Building the project 428
- 452. CHAPTER FIFTYTWO DESKTOP AND MOBILEDEVELOPMENT USING RINGQT In this chapter we will learn how to use the Qt framework classes in our Ring applications to create Desktop and Mobile Applications. 52.1 The First GUI Application In this example we will create an application to ask the user about his/her name. When the user type the name in the textbox then click on “Say Hello” button, the textbox value will be updated by adding “Hello ” to the name. Load "guilib.ring" MyApp = New qApp { win1 = new qWidget() { setwindowtitle("Hello World") setGeometry(100,100,370,250) label1 = new qLabel(win1) { settext("What is your name ?") setGeometry(10,20,350,30) setalignment(Qt_AlignHCenter) } btn1 = new qpushbutton(win1) { setGeometry(10,200,100,30) settext("Say Hello") setclickevent("pHello()") } btn1 = new qpushbutton(win1) { setGeometry(150,200,100,30) settext("Close") setclickevent("pClose()") } lineedit1 = new qlineedit(win1) { setGeometry(10,100,350,30) } show() } 429
- 453. Ring Documentation, Release1.4.1 exec() } Func pHello lineedit1.settext( "Hello " + lineedit1.text()) Func pClose MyApp.quit() Program Output: At first we type the name in the textbox Then we click on the say hello button 52.1. The First GUI Application 430
- 454. Ring Documentation, Release1.4.1 52.2 Using Layout The next example is just an upgrade to the previous application to use the vertical layout. Load "guilib.ring" MyApp = New qApp { win1 = new qWidget() { setwindowtitle("Hello World") setGeometry(100,100,400,130) label1 = new qLabel(win1) { settext("What is your name ?") setGeometry(10,20,350,30) setalignment(Qt_AlignHCenter) } btn1 = new qpushbutton(win1) { setGeometry(10,200,100,30) settext("Say Hello") setclickevent("pHello()") } btn2 = new qpushbutton(win1) { setGeometry(150,200,100,30) settext("Close") setclickevent("pClose()") } lineedit1 = new qlineedit(win1) { setGeometry(10,100,350,30) } layout1 = new qVBoxLayout() { addwidget(label1) addwidget(lineedit1) addwidget(btn1) addwidget(btn2) } win1.setlayout(layout1) show() } exec() } Func pHello lineedit1.settext( "Hello " + lineedit1.text()) Func pClose MyApp.quit() The application during the runtime! 52.2. Using Layout 431
- 455. Ring Documentation, Release1.4.1 52.3 Using the QTextEdit Class In this example we will use the QTextEdit Class Load "guilib.ring" New qApp { win1 = new qWidget() { setwindowtitle("QTextEdit Class") setGeometry(100,100,500,500) new qtextedit(win1) { setGeometry(10,10,480,480) } show() } exec() } During the runtime we can paste rich text in the qtextedit widget 52.3. Using the QTextEdit Class 432
- 456. Ring Documentation, Release1.4.1 52.4 Using the QListWidget Class In this example we will use the QListWidget Class Load "guilib.ring" New qApp { win1 = new qWidget() { setGeometry(100,100,400,400) list1 = new qlistwidget(win1) { setGeometry(150,100,200,200) alist = ["one","two","three","four","five"] for x in alist additem(x) next setcurrentrow(3,2) win1.setwindowtitle("Items Count : " + count() ) } 52.4. Using the QListWidget Class 433
- 457. Ring Documentation, Release1.4.1 btn1 = new qpushbutton(win1) { setGeometry(10,200,100,30) settext("selected item") setclickevent("pWork()") } btn2 = new qpushbutton(win1) { setGeometry(10,240,100,30) settext("Delete item") setclickevent("pWork2()") } show() } exec() } func pWork btn1.settext(string(list1.currentrow())) func pWork2 list1 { takeitem(currentrow()) } The application during the runtime 52.4. Using the QListWidget Class 434
- 458. Ring Documentation, Release1.4.1 Another Example: Load "guilib.ring" New qApp { win1 = new qWidget() { setGeometry(100,100,500,400) list1 = new qlistwidget(win1) { setGeometry(150,100,200,200) alist = ["one","two","three","four","five"] for x in alist additem(x) next setcurrentrow(3,2) win1.setwindowtitle("Items Count : " + count() ) } btn1 = new qpushbutton(win1) { setGeometry(10,200,100,30) settext("selected item") setclickevent("pWork()") } btn2 = new qpushbutton(win1) { setGeometry(10,240,100,30) settext("Delete item") setclickevent("pWork2()") } show() } exec() } func pWork nbrOfItems = list1.count() curItemNbr = list1.currentrow() curValue = list1.item(list1.currentrow()).text() win1.setwindowtitle( "After Select - NbrOfItems: " + nbrOfItems + " CurItemNbr: " + curItemNbr + " CurValue: " + curValue ) btn1.settext( string(list1.currentrow() ) + " --- " + list1.item(list1.currentrow()).text() ) func pWork2 list1 { takeitem(currentrow()) nbrOfItems = count() curItemNbr = currentrow() curValue = item(currentrow()).text() 52.4. Using the QListWidget Class 435
- 459. Ring Documentation, Release1.4.1 win1.setwindowtitle("After Delete - NbrOfItems: " + nbrOfItems + " CurItemNbr: " + curItemNbr +" CurValue: " + curValue ) } 52.5 Using QTreeView and QFileSystemModel In this example we will learn how to use the QTreeView widget to represent the File System Load "guilib.ring" New qApp { win1 = New qWidget() { setwindowtitle("Using QTreeView and QFileSystemModel") setGeometry(100,100,500,400) New qtreeview(win1) { setGeometry(00,00,500,400) oDir = new QDir() ofile = new QFileSystemModel() ofile.setrootpath(oDir.currentpath()) setmodel(ofile) } show() } exec() } The application during the runtime 52.5. Using QTreeView and QFileSystemModel 436
- 460. Ring Documentation, Release1.4.1 52.6 Using QTreeWidget and QTreeWidgetItem In this example we will learn about using the QTreeWidget and QTreeWidgetItem classes Load "guilib.ring" New qApp { win1 = new qWidget() { setwindowtitle("TreeWidget") setGeometry(100,100,400,400) layout1 = new qvboxlayout() tree1 = new qtreewidget(win1) { setGeometry(00,00,400,400) setcolumncount(1) myitem = new qtreewidgetitem() myitem.settext(0,"The First Step") addtoplevelitem(myitem) for x = 1 to 10 myitem2 = new qtreewidgetitem() myitem2.settext(0,"hello"+x) myitem.addchild(myitem2) 52.6. Using QTreeWidget and QTreeWidgetItem 437
- 461. Ring Documentation, Release1.4.1 for y = 1 to 10 myitem3 = new qtreewidgetitem() myitem3.settext(0,"hello"+x) myitem2.addchild(myitem3) next next setheaderlabel("Steps Tree") } layout1.addwidget(tree1) setlayout(layout1) show() } exec() } The application during the runtime 52.7 Using QComboBox Class In this example we will learn about using the QComboBox class 52.7. Using QComboBox Class 438
- 462. Ring Documentation, Release1.4.1 Load "guilib.ring" New qApp { win1 = new qWidget() { setwindowtitle("Using QComboBox") setGeometry(100,100,400,400) New QComboBox(win1) { setGeometry(150,100,200,30) alist = ["one","two","three","four","five"] for x in aList additem(x,0) next } show() } exec() } The application during the runtime 52.8 Creating Menubar In this example we will learn about using the QMenuBar class 52.8. Creating Menubar 439
- 463. Ring Documentation, Release1.4.1 Load "guilib.ring" MyApp = New qApp { win1 = new qWidget() { setwindowtitle("Using QMenubar") setGeometry(100,100,400,400) menu1 = new qmenubar(win1) { sub1 = addmenu("File") sub2 = addmenu("Edit") sub3 = addmenu("Help") sub1 { oAction = new qAction(win1) { settext("New") } addaction(oAction) oAction = new qAction(win1) { settext("Open") } addaction(oAction) oAction = new qAction(win1) { settext("Save") } addaction(oAction) oAction = new qAction(win1) { settext("Save As") } addaction(oAction) addseparator() oAction = new qaction(win1) { settext("Exit") setclickevent("myapp.quit()") } addaction(oAction) } sub2 { oAction = new qAction(win1) { settext("Cut") } addaction(oAction) oAction = new qAction(win1) { settext("Copy") } addaction(oAction) oAction = new qAction(win1) { settext("Paste") } addaction(oAction) addseparator() oAction = new qAction(win1) { settext("Select All") } addaction(oAction) } sub3 { oAction = new qAction(win1) { 52.8. Creating Menubar 440
- 464. Ring Documentation, Release1.4.1 settext("Reference") } addaction(oAction) sub4 = addmenu("Sub Menu") sub4 { oAction = new qAction(win1) { settext("Website") } addaction(oAction) oAction = new qAction(win1) { settext("Forum") } addaction(oAction) oAction = new qAction(win1) { settext("Blog") } addaction(oAction) } addseparator() oAction = new qAction(win1) { settext("About") } addaction(oAction) } } show() } exec() } The application during the runtime 52.8. Creating Menubar 441
- 465. Ring Documentation, Release1.4.1 52.9 Creating Toolbar In this example we will learn about using the QToolBar class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("Using QToolbar") setGeometry(100,100,600,400) abtns = [ new qpushbutton(win1) { settext("Add") } , new qpushbutton(win1) { settext("Edit") } , new qpushbutton(win1) { settext("Find") } , new qpushbutton(win1) { settext("Delete") } , new qpushbutton(win1) { settext("Exit") setclickevent("win1.close()") } ] tool1 = new qtoolbar(win1) { for x in abtns addwidget(x) addseparator() next setmovable(true) setGeometry(0,0,500,30) 52.9. Creating Toolbar 442
- 466. Ring Documentation, Release1.4.1 setFloatable(true) } show() } exec() } The application during the runtime 52.10 Creating StatusBar In this example we will learn about using the QStatusBar class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("Using QStatusbar") setGeometry(100,100,400,400) status1 = new qstatusbar(win1) { showmessage("Ready!",0) 52.10. Creating StatusBar 443
- 467. Ring Documentation, Release1.4.1 } setstatusbar(status1) show() } exec() } The application during the runtime 52.11 Using QDockWidget In this example we will learn about using the QDockWidget class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("QDockWidget") setGeometry(100,100,400,400) label1 = new qlabel(win1) { settext("Hello") 52.11. Using QDockWidget 444
- 468. Ring Documentation, Release1.4.1 setGeometry(300,300,100,100) } label2 = new qlabel(win1) { settext("How are you ?") setGeometry(100,100,100,100) } dock1 = new qdockwidget(win1,0) { setwidget(label1) SetAllowedAreas(1) } dock2 = new qdockwidget(win1,0) { setwidget(label2) SetAllowedAreas(2) } adddockwidget(Qt_LeftDockWidgetArea,dock1,Qt_Horizontal) adddockwidget(Qt_LeftDockWidgetArea,dock2,Qt_Vertical) show() } exec() } The application during the runtime 52.11. Using QDockWidget 445
- 469. Ring Documentation, Release1.4.1 52.12 Using QTabWidget In this example we will learn about using the QTabWidget class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("Using QTabWidget") setGeometry(100,100,400,400) page1 = new qwidget() { new qpushbutton(page1) { settext("The First Page") } } page2 = new qwidget() { new qpushbutton(page2) { settext("The Second Page") } } page3 = new qwidget() { new qpushbutton(page3) { settext("The Third Page") } } tab1 = new qtabwidget(win1) { inserttab(0,page1,"Page 1") inserttab(1,page2,"Page 2") inserttab(2,page3,"Page 3") setGeometry(100,100,400,400) } status1 = new qstatusbar(win1) { showmessage("Ready!",0) } setstatusbar(status1) showMaximized() } exec() } The application during the runtime 52.12. Using QTabWidget 446
- 470. Ring Documentation, Release1.4.1 52.13 Using QTableWidget In this example we will learn about using the QTableWidget class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,1100,370) setwindowtitle("Using QTableWidget") Table1 = new qTableWidget(win1) { setrowcount(10) setcolumncount(10) setGeometry(0,0,800,400) setselectionbehavior(QAbstractItemView_SelectRows) for x = 1 to 10 for y = 1 to 10 item1 = new qtablewidgetitem("R"+X+"C"+Y) setitem(x-1,y-1,item1) next next } setcentralwidget(table1) show() } 52.13. Using QTableWidget 447
- 471. Ring Documentation, Release1.4.1 exec() } The application during the runtime 52.14 Using QProgressBar In this example we will learn about using the QProgressBar class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,600,150) setwindowtitle("Using QProgressBar") for x = 10 to 100 step 10 new qprogressbar(win1) { setGeometry(100,x,350,30) setvalue(x) } next show() } exec() } The application during the runtime 52.14. Using QProgressBar 448
- 472. Ring Documentation, Release1.4.1 52.15 Using QSpinBox In this example we will learn about using the QSpinBox class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,450,260) setwindowtitle("Using QSpinBox") new qspinbox(win1) { setGeometry(50,100,350,30) setvalue(50) } show() } exec() } The application during the runtime 52.15. Using QSpinBox 449
- 473. Ring Documentation, Release1.4.1 52.16 Using QSlider In this example we will learn about using the QSlider class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,500,400) setwindowtitle("Using QSlider") new qslider(win1) { setGeometry(100,100,50,130) settickinterval(50) } new qslider(win1) { setGeometry(100,250,250,30) settickinterval(50) setorientation(Qt_Horizontal) } show() } exec() } The application during the runtime 52.16. Using QSlider 450
- 474. Ring Documentation, Release1.4.1 52.17 Using QDateEdit In this example we will learn about using the QDateEdit class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("Using QDateEdit") setGeometry(100,100,250,100) new qdateedit(win1) { setGeometry(20,40,220,30) } show() } exec() } The application during the runtime 52.17. Using QDateEdit 451
- 475. Ring Documentation, Release1.4.1 52.18 Using QDial In this example we will learn about using the QDial class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,450,500) setwindowtitle("Using QDial") new qdial(win1) { setGeometry(100,100,250,300) } show() } exec() } The application during the runtime 52.18. Using QDial 452
- 476. Ring Documentation, Release1.4.1 Another Example Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,450,500) setwindowtitle("Using QDial") button1 = new QPushButton(win1){ setGeometry(100,350,100,30) settext("Increment") setClickEvent("pIncrement()") } button2 = new QPushButton(win1){ setGeometry(250,350,100,30) settext("Decrement") setClickEvent("pDecrement()") } pdial = new qdial(win1) { 52.18. Using QDial 453
- 477. Ring Documentation, Release1.4.1 setGeometry(100,50,250,300) setNotchesVisible(true) setValue(50) SetValueChangedEvent("pDialMove()") } lineedit1 = new qlineedit(win1) { setGeometry(200,400,50,30) setalignment(Qt_AlignHCenter) settext(string(pdial.value())) setreturnPressedEvent("pPress()") } show() } exec() } func pIncrement pdial{val=value()} pdial.setvalue(val+1) lineedit1{settext(string(val+1))} func pDecrement pdial{val=value()} pdial.setvalue(val-1) lineedit1{settext(string(val-1))} func pPress lineedit1{val=text()} pdial.setvalue(number(val)) func pDialMove lineedit1.settext(""+pdial.value()) 52.18. Using QDial 454
- 478. Ring Documentation, Release1.4.1 52.19 Using QWebView In this example we will learn about using the QWebView class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("QWebView") myweb = new qwebview(win1) { setGeometry(10,10,600,600) loadpage(new qurl("http://google.com")) } setcentralwidget(myweb) showMaximized() } exec() } The application during the runtime 52.19. Using QWebView 455
- 479. Ring Documentation, Release1.4.1 52.20 Using QCheckBox In this example we will learn about using the QCheckBox class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("Using QCheckBox") new qcheckbox(win1) { setGeometry(100,100,100,30) settext("New Customer!") } showMaximized() } exec() } The application during the runtime 52.20. Using QCheckBox 456
- 480. Ring Documentation, Release1.4.1 Another Example: Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,400,300) setwindowtitle("Using QCheckBox") ### 0-Unchecked 1-Checked CheckBox = new qcheckbox(win1) { setGeometry(100,100,160,30) settext("New Customer!") setclickedEvent("HandleClickEvent()") } show() } exec() } Func HandleClickEvent if CheckBox.isChecked() = 1 CheckBox.settext("New Customer. Check 1-ON") else CheckBox.settext("New Customer. Check 0-OFF") ok 52.21 Using QRadioButton and QButtonGroup In this example we will learn about using the QRadioButton and QButtonGroup classes Load "guilib.ring" 52.21. Using QRadioButton and QButtonGroup 457
- 481. Ring Documentation, Release1.4.1 New qApp { win1 = new qMainWindow() { setwindowtitle("Using QRadioButton") new qradiobutton(win1) { setGeometry(100,100,100,30) settext("One") } new qradiobutton(win1) { setGeometry(100,150,100,30) settext("Two") } new qradiobutton(win1) { setGeometry(100,200,100,30) settext("Three") } group2 = new qbuttongroup(win1) { btn4 = new qradiobutton(win1) { setGeometry(200,150,100,30) settext("Four") } btn5 = new qradiobutton(win1) { setGeometry(200,200,100,30) settext("Five") } addbutton(btn4,0) addbutton(btn5,0) } showMaximized() } exec() } The application during the runtime 52.21. Using QRadioButton and QButtonGroup 458
- 482. Ring Documentation, Release1.4.1 52.22 Adding Hyperlink to QLabel In this example we will learn about creating Hyperlink using the QLabel class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("QLabel - Hyperlink") new qlabel(win1) { setGeometry(100,100,100,30) setopenexternallinks(true) settext('<a href="http://google.com">Google</a>') } showMaximized() } exec() } The application during the runtime 52.22. Adding Hyperlink to QLabel 459
- 483. Ring Documentation, Release1.4.1 52.23 QVideoWidget and QMediaPlayer In this example we will learn about using the QVideoWidget and QMediaPlayer classes to play a group of movies from different positions at the same time Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("QVideoWidget") btn1 = new qpushbutton(win1) { setGeometry(0,0,100,30) settext("play") setclickevent("player.play() player2.play() player3.play() player4.play()") } videowidget = new qvideowidget(win1) { setGeometry(50,50,600,300) setstylesheet("background-color: black") } videowidget2 = new qvideowidget(win1) { setGeometry(700,50,600,300) setstylesheet("background-color: black") } videowidget3 = new qvideowidget(win1) { setGeometry(50,370,600,300) setstylesheet("background-color: black") } videowidget4 = new qvideowidget(win1) { 52.23. QVideoWidget and QMediaPlayer 460
- 484. Ring Documentation, Release1.4.1 setGeometry(700,370,600,300) setstylesheet("background-color: black") } player = new qmediaplayer() { setmedia(new qurl("1.mp4")) setvideooutput(videowidget) setposition(35*60*1000) } player2 = new qmediaplayer() { setmedia(new qurl("2.mp4")) setvideooutput(videowidget2) setposition(23*60*1000) } player3 = new qmediaplayer() { setmedia(new qurl("3.mp4")) setvideooutput(videowidget3) setposition(14.22*60*1000) } player4 = new qmediaplayer() { setmedia(new qurl("4.avi")) setvideooutput(videowidget4) setposition(8*60*1000) } showfullscreen() } exec() } The application during the runtime 52.23. QVideoWidget and QMediaPlayer 461
- 485. Ring Documentation, Release1.4.1 52.24 Using QFrame In this example we will learn about using the QFrame class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("Using QFrame") for x = 0 to 10 frame1 = new qframe(win1,0) { setGeometry(100,20+50*x,400,30) setframestyle(QFrame_Raised | QFrame_WinPanel) } next showMaximized() } exec() } The application during the runtime 52.24. Using QFrame 462
- 486. Ring Documentation, Release1.4.1 52.25 Display Image using QLabel In this example we will learn about displaying an image using the QLabel widget Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("QLabel - Display image") new qlabel(win1) { image = new qpixmap("b:/mahmoud/photo/advice.jpg") setpixmap(image) setGeometry(0,0,image.width(),image.height()) } 52.25. Display Image using QLabel 463
- 487. Ring Documentation, Release1.4.1 showMaximized() } exec() } The application during the runtime 52.26 Menubar and StyleSheet Example In this example we will learn about creating menubar and setting the window stylesheet Load "guilib.ring" New qApp { 52.26. Menubar and StyleSheet Example 464
- 488. Ring Documentation, Release1.4.1 win1 = new qMainWindow() { setwindowtitle("Menubar") menu1 = new qmenubar(win1) { sub1 = addmenu("File") sub1 { oAction = new qAction(win1) { settext("New") setenabled(false) } addaction(oAction) oAction = new qAction(win1) { settext("Open") setcheckable(true) setchecked(true) setstatustip("open new file") } addaction(oAction) oAction = new qAction(win1) { settext("Save") } addaction(oAction) oAction = new qAction(win1) { settext("Save As") } addaction(oAction) addseparator() oAction = new qaction(win1) oAction.settext("Exit") oAction.setclickevent("myapp.quit()") addaction(oAction) } } status1 = new qstatusbar(win1) { showmessage("Ready!",0) } setmenubar(menu1) setmousetracking(true) setstatusbar(status1) setStyleSheet("color: black; selection-color: black; selection-background-color:white ; background: QLinearGradient(x1: 0, y1: 0, x2: 0, y2: 1, stop: 0 #eef, stop: 1 #ccf);") showmaximized() } exec() } The application during the runtime 52.26. Menubar and StyleSheet Example 465
- 489. Ring Documentation, Release1.4.1 52.27 QLineEdit Events and QMessageBox In this example we will learn about using QLineEdit Events and displaying a Messagebox Load "guilib.ring" MyApp = New qApp { win1 = new qWidget() { setwindowtitle("Welcome") setGeometry(100,100,400,300) label1 = new qLabel(win1) { settext("What is your name ?") setGeometry(10,20,350,30) setalignment(Qt_AlignHCenter) } btn1 = new qpushbutton(win1) { setGeometry(10,200,100,30) settext("Say Hello") setclickevent("pHello()") } btn1 = new qpushbutton(win1) { setGeometry(150,200,100,30) settext("Close") setclickevent("pClose()") } lineedit1 = new qlineedit(win1) { setGeometry(10,100,350,30) settextchangedevent("pChange()") setreturnpressedevent("penter()") } 52.27. QLineEdit Events and QMessageBox 466
- 490. Ring Documentation, Release1.4.1 show() } exec() } Func pHello lineedit1.settext( "Hello " + lineedit1.text()) Func pClose MyApp.quit() Func pChange win1 { setwindowtitle( lineedit1.text() ) } Func pEnter new qmessagebox(win1) { setwindowtitle("Thanks") settext("Hi " + lineedit1.text() ) setstylesheet("background-color : white") show() } The application during the runtime 52.27. QLineEdit Events and QMessageBox 467
- 491. Ring Documentation, Release1.4.1 52.28 Other Widgets Events Each Qt signal can be used in RingQt, just add Set before the signal name and add event after the signal name to get the method that can be used to determine the event code. For example the QProgressBar class contains a signal named valueChanged() To use it just use the function setVal- ueChangedEvent() Example: Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("QProgressBar valueChanged Event") progress1 = new qprogressbar(win1) { setGeometry(100,100,350,30) setvalue(10) setvaluechangedevent("pChange()") } new qpushbutton(win1) { setGeometry(10,10,100,30) settext("increase") setclickevent("pIncrease()") } showMaximized() } 52.28. Other Widgets Events 468
- 492. Ring Documentation, Release1.4.1 exec() } func pIncrease progress1 { setvalue(value()+1) } func pchange win1.setwindowtitle("value : " + progress1.value() ) The application during the runtime Another example for the stateChanged event of the QCheckBox class Load "guilib.ring" New qApp { win1 = new qMainWindow() { setwindowtitle("QCheckBox") new qcheckbox(win1) { setGeometry(100,100,100,30) settext("New Customer!") setstatechangedevent("pchange()") } showMaximized() } exec() } Func pChange new qMessageBox(Win1) { setWindowTitle("Checkbox") settext("State Changed!") show() } The application during the runtime 52.28. Other Widgets Events 469
- 493. Ring Documentation, Release1.4.1 52.29 Using the QTimer Class In this example we will learn about using the QTimer class Load "guilib.ring" new qApp { win1 = new qwidget() { setgeometry(100,100,200,70) setwindowtitle("Timer") label1 = new qlabel(win1) { setgeometry(10,10,200,30) settext(thetime()) } new qtimer(win1) { setinterval(1000) settimeoutevent("pTime()") start() } show() } exec() } func ptime label1.settext(thetime()) Func thetime return "Time : " + Time() The application during the runtime 52.29. Using the QTimer Class 470
- 494. Ring Documentation, Release1.4.1 52.30 Using QProgressBar and Timer In this example we will learn about using the “animated” QProgressBar class and Timer ###------------------------------------ ### ProgressBar and Timer Example Load "guilib.ring" new qApp { win1 = new qwidget() { setgeometry(100,100,400,100) setwindowtitle("Timer and ProgressBar") LabelMan = new qlabel(win1) { setgeometry(10,10,200,30) settext(theTime()) ### ==>> func } TimerMan = new qtimer(win1) { setinterval(1000) settimeoutevent("pTime()") ### ==>> func start() } BarMan = new qprogressbar(win1) { setGeometry(100,50,300,10) ### Position X y, Length, Thickness setvalue(0) ### Percent filled } show() } exec() } func pTime LabelMan.settext(theTime()) ### ==>> func Increment = 10 if BarMan.value() >= 100 ### ProgressBar start over. BarMan.setvalue(0) ok BarMan{ setvalue(value() + Increment) } 52.30. Using QProgressBar and Timer 471
- 495. Ring Documentation, Release1.4.1 Func theTime return "Time : " + Time() 52.31 Display Scaled Image using QLabel In this example we will learn about displaying and scaling an image so that it looks “animated” using the QLabel widget Load "guilib.ring" #---------------------------------------------------- # REQUIRES: image = "C:RINGbinstock.jpg" # imageStock: start dimensions for growing image imageW = 200 ; imageH = 200 ; GrowBy = 4 ###---------------------------------------------------- ### Window and Box Size dimensions WinWidth = 1280 ; WinHeight = 960 BoxWidth = WinWidth -80 ; BoxHeight = WinHeight -80 ###---------------------------------------------------- New qapp { win1 = new qwidget() { setgeometry(50,50, WinWidth,WinHeight) setwindowtitle("Animated Image - Display Image Scaled and Resized") imageStock = new qlabel(win1) { image = new qpixmap("C:RINGbinstock.jpg") AspectRatio = image.width() / image.height() imageW = 200 imageH = imageH / AspectRatio ### Size-H, Size-V, Aspect, Transform setpixmap(image.scaled(imageW , imageH ,0,0)) PosLeft = (BoxWidth - imageW ) / 2 PosTop = (BoxHeight - imageH ) / 2 52.31. Display Scaled Image using QLabel 472
- 496. Ring Documentation, Release1.4.1 setGeometry(PosLeft,PosTop,imageW,imageH) } TimerMan = new qtimer(win1) { setinterval(100) ### interval 100 millisecs. settimeoutevent("pTime()") ### ==>> func start() } show() } exec() } ###------------------------------------------------------ ### Fuction TimerMan: calling interval 100 milliseconds func pTime ### Stop Timer when image is size of Window area if imageW > BoxWidth TimerMan.stop() imageStock.clear() ### Will clear the image ok ### Grow image imageW += GrowBy imageH = imageW / AspectRatio ### Scaled Image: Size-H, Size-V, Aspect, Transform imageStock.setpixmap(image.scaled(imageW , imageH ,0,0)) ### Center the image PosLeft = (WinWidth - imageW ) / 2 PosTop = (WinHeight - imageH ) / 2 imageStock.setGeometry(PosLeft,PosTop,imageW,imageH) 52.32 Using the QFileDialog Class Example Load "guilib.ring" New qapp { win1 = new qwidget() { setwindowtitle("open file") setgeometry(100,100,400,400) new qpushbutton(win1) { setgeometry(10,10,200,30) settext("open file") setclickevent("pOpen()") } show() } 52.32. Using the QFileDialog Class 473
- 497. Ring Documentation, Release1.4.1 exec() } Func pOpen new qfiledialog(win1) { cName = getopenfilename(win1,"open file","c:","source files(*.ring)") win1.setwindowtitle(cName) } The application during the runtime 52.33 Drawing using QPainter In this example we will learn about drawing using the QPainter class Load "guilib.ring" New qapp { win1 = new qwidget() { setwindowtitle("Drawing using QPainter") setgeometry(100,100,500,500) label1 = new qlabel(win1) { setgeometry(10,10,400,400) settext("") } new qpushbutton(win1) { setgeometry(200,400,100,30) settext("draw") setclickevent("draw()") } show() } 52.33. Drawing using QPainter 474
- 498. Ring Documentation, Release1.4.1 exec() } Func draw p1 = new qpicture() color = new qcolor() { setrgb(0,0,255,255) } pen = new qpen() { setcolor(color) setwidth(10) } new qpainter() { begin(p1) setpen(pen) drawline(500,150,950,450) drawline(950,550,500,150) endpaint() } label1 { setpicture(p1) show() } The application during the runtime 52.33. Drawing using QPainter 475
- 499. Ring Documentation, Release1.4.1 52.34 Printing using QPrinter In this example we will learn how to print to PDF file using QPrinter Load "guilib.ring" new qApp { win1 = new qwidget() { setwindowtitle("Printer") setgeometry(100,100,500,500) myweb = new qwebview(win1) { setgeometry(100,100,1000,500) loadpage(new qurl("http://google.com")) } new qpushbutton(win1) { setGeometry(20,20,100,30) settext("Print") setclickevent("print()") } showmaximized() 52.34. Printing using QPrinter 476
- 500. Ring Documentation, Release1.4.1 } exec() } func print printer1 = new qPrinter(0) { setoutputformat(1) # 1 = pdf setoutputfilename("test.pdf") painter = new qpainter() { begin(printer1) myfont = new qfont("Times",50,-1,0) setfont(myfont) drawtext(100,100,"test") printer1.newpage() drawtext(100,100,"test2") endpaint() } } printer1 = new qPrinter(0) { setoutputformat(1) setoutputfilename("test2.pdf") myweb.print(printer1) myweb.show() } system ("test.pdf") system ("test2.pdf") 52.35 Creating More than one Window The next example demonstrates how to create more than one window Load "guilib.ring" app1 = new qapp { win1 = new qwidget() { setwindowtitle("First") setgeometry(100,100,500,500) new qpushbutton(win1) { setgeometry(100,100,100,30) settext("close") setclickevent("app1.quit()") } new qpushbutton(win1) { setgeometry(250,100,100,30) settext("Second") setclickevent("second()") } showmaximized() } exec() } 52.35. Creating More than one Window 477
- 501. Ring Documentation, Release1.4.1 func second win2 = new qwidget() { setwindowtitle("Second") setgeometry(100,100,500,500) setwindowflags(Qt_dialog) show() } The application during the runtime 52.36 Playing Sound Example: Load "guilib.ring" new qapp { win1 = new qwidget() { setwindowtitle("play sound!") show() } new qmediaplayer() { setmedia(new qurl("footstep.wav")) setvolume(50) play() } exec() } 52.37 Using the QColorDialog Class Example: 52.36. Playing Sound 478
- 502. Ring Documentation, Release1.4.1 Load "guilib.ring" oApp = new myapp { start() } Class MyApp oColor win1 Func start myapp = new qapp win1 = new qMainWindow() { setwindowtitle("Color Dialog") setgeometry(100,100,400,400) } new qpushbutton(win1) { setgeometry(10,10,100,30) settext("Get Color") setclickevent("oApp.pColor()") } win1.show() myapp.exec() Func pColor myobj = new qcolordialog() aColor = myobj.GetColor() r=acolor[1] g=acolor[2] b=acolor[3] win1.setstylesheet("background-color: rgb("+r+", " + g+ "," + b + ")") The application during the runtime 52.37. Using the QColorDialog Class 479
- 503. Ring Documentation, Release1.4.1 52.38 Using qLCDNumber Class In this example we will learn about using the qLCDNumber class Load "guilib.ring" New qApp { win1 = new qWidget() { setwindowtitle("LCD Number") setgeometry(100,100,250,120) new qLCDNumber(win1) { setgeometry(10,10,100,40) display(100) } new qLCDNumber(win1) { setgeometry(10,60,100,40) display(80) } show() } exec() } The application during the runtime 52.39 Movable Label Example Load "guilib.ring" new qApp { win1 = new qWidget() { 52.38. Using qLCDNumber Class 480
- 504. Ring Documentation, Release1.4.1 label1 = new qLabel(win1) { setText("Welcome") setgeometry(10,10,200,50) setstylesheet("color: purple ; font-size: 30pt;") } new qTimer(win1) { setInterVal(10) setTimeOutEvent("pMove()") start() } setWindowTitle("Movable Label") setgeometry(100,100,600,80) setStyleSheet("background-color: white;") show() } exec() } Func pMove label1 { move(x()+1,y()) if x() > 600 move(10,y()) ok } The application during the runtime 52.40 QMessagebox Example In this section we will learn how to check the output of the Message box Load "guilib.ring" new qApp { win1 = new qWidget() { label1 = new qpushbutton(win1) { setText("Test") setgeometry(10,10,200,50) 52.40. QMessagebox Example 481
- 505. Ring Documentation, Release1.4.1 setstylesheet("color: purple ; font-size: 30pt;") setclickevent("pWork()") } setWindowTitle("Messagebox") setgeometry(100,100,600,80) setStyleSheet("background-color: white;") show() } exec() } func pWork new qmessagebox(win1) { setwindowtitle("messagebox title") settext("messagebox text") setInformativeText("Do you want to save your changes?") setstandardbuttons(QMessageBox_Yes | QMessageBox_No | QMessageBox_Close) result = exec() win1 { if result = QMessageBox_Yes setwindowtitle("Yes") but result = QMessageBox_No setwindowtitle("No") but result = QMessageBox_Close setwindowtitle("Close") ok } } The application during the runtime 52.41 Using QInputDialog Class In the next example we will learn about using the QInputDialog class 52.41. Using QInputDialog Class 482
- 506. Ring Documentation, Release1.4.1 Load "guilib.ring" New QApp { Win1 = New QWidget () { SetGeometry(100,100,400,400) SetWindowTitle("Input Dialog") New QPushButton(win1) { SetText ("Input Dialog") SetGeometry(100,100,100,30) SetClickEvent("pWork()") } Show() } exec() } Func pWork oInput = New QInputDialog(win1) { setwindowtitle("What is your name?") setgeometry(100,100,400,50) setlabeltext("User Name") settextvalue("Mahmoud") lcheck = exec() if lCheck win1.setwindowtitle(oInput.textvalue()) ok } The application during the runtime 52.41. Using QInputDialog Class 483
- 507. Ring Documentation, Release1.4.1 52.42 Dialog Functions We have the next functions SetDialogIcon(cIconFile) MsgInfo(cTitle,cMessage) ConfirmMsg(cTitle,cMessage) --> lResult InputBox(cTitle,cMessage) --> cValue InputBoxInt(cTitle,cMessage) --> nValue InputBoxNum(cTitle,cMessage) --> nValue InputBoxPass(cTitle,cMessage) --> cValue Example load "guilib.ring" new qApp { SetDialogIcon("notepad.png") msginfo(:Ring,:Welcome) see confirmMsg(:Ring,"Are you sure?") + nl see InputBoxNum(:Ring,"Enter Number(double) :") + nl see InputBox(:Ring,"Enter Value :") + nl see InputBoxInt(:Ring,"Enter Number(int)") + nl see InputBoxPass(:Ring,"Enter Password") +nl } 52.42. Dialog Functions 484
- 508. Ring Documentation, Release1.4.1 52.43 KeyPress and Mouse Move Events In this example we will learn how to use the Events Filter to know about KeyPress and Mouse Move Events Load "guilib.ring" new qApp { win1 = new qWidget() { setWindowTitle("Test using Event Filter!") setGeometry(100,100,400,400) setmousetracking(true) myfilter = new qallevents(win1) myfilter.setKeyPressEvent("pWork()") myfilter.setMouseButtonPressevent("pClick()") myfilter.setmousemoveevent("pMove()") installeventfilter(myfilter) show() } exec() } func pWork win1.setwindowtitle('KeyPress! : ' + myfilter.getkeycode()) func pClick new qmessagebox(win1) { setgeometry(100,100,400,100) setwindowtitle("click event!") settext("x : " + myfilter.getx() + " y : " + myfilter.gety() + " button : " + myfilter.getbutton() ) show() } func pMove win1.setwindowtitle("Mouse Move , X : " + myfilter.getx() + " Y : " + myfilter.gety() ) The application during the runtime 52.43. KeyPress and Mouse Move Events 485
- 509. Ring Documentation, Release1.4.1 52.44 Moving Objects using the Mouse In the next example we will learn how to program movable objects where the user can move a label Load "guilib.ring" lPress = false nX = 0 nY = 0 new qApp { win1 = new qWidget() { setWindowTitle("Move this label!") setGeometry(100,100,400,400) setstylesheet("background-color:white;") Label1 = new qLabel(Win1){ setGeometry(100,100,200,50) setText("Welcome") setstylesheet("font-size: 30pt") myfilter = new qallevents(label1) myfilter.setEnterevent("pEnter()") myfilter.setLeaveevent("pLeave()") 52.44. Moving Objects using the Mouse 486
- 510. Ring Documentation, Release1.4.1 myfilter.setMouseButtonPressEvent("pPress()") myfilter.setMouseButtonReleaseEvent("pRelease()") myfilter.setMouseMoveEvent("pMove()") installeventfilter(myfilter) } show() } exec() } Func pEnter Label1.setStyleSheet("background-color: purple; color:white;font-size: 30pt;") Func pLeave Label1.setStyleSheet("background-color: white; color:black;font-size: 30pt;") Func pPress lPress = True nX = myfilter.getglobalx() ny = myfilter.getglobaly() Func pRelease lPress = False pEnter() Func pMove nX2 = myfilter.getglobalx() ny2 = myfilter.getglobaly() ndiffx = nX2 - nX ndiffy = nY2 - nY if lPress Label1 { move(x()+ndiffx,y()+ndiffy) setStyleSheet("background-color: Green; color:white;font-size: 30pt;") nX = nX2 ny = nY2 } ok The application during the runtime 52.44. Moving Objects using the Mouse 487
- 511. Ring Documentation, Release1.4.1 52.44. Moving Objects using the Mouse 488
- 512. Ring Documentation, Release1.4.1 52.44. Moving Objects using the Mouse 489
- 513. Ring Documentation, Release1.4.1 52.45 Inheritance from GUI Classes Example : Load "guilib.ring" New MyWindow() new qApp { exec() } class mywindow from qwidget Func init super.init() setwindowtitle("First Window") setgeometry(100,100,400,400) setstylesheet("background-color: purple;") settooltip("my first window!") show() The application during the runtime 52.45. Inheritance from GUI Classes 490
- 514. Ring Documentation, Release1.4.1 52.46 Using QDesktopWidget Class In the next example we will learn about using the QDesktopWidget class Load "guilib.ring" New qApp { win1 = New qWidget() { resize(400,400) btn1 = new qPushbutton(win1) { setText("Center") move(100,100) resize(100,30) setClickEvent("pCenter()") } Show() } exec() } Func pCenter oDesktop = new qDesktopWidget() 52.46. Using QDesktopWidget Class 491
- 515. Ring Documentation, Release1.4.1 oRect = oDesktop.screenGeometry( oDesktop.primaryScreen() ) win1.move((oRect.width()-win1.width()) /2 , (oRect.Height()-win1.Height())/2 ) win1.show() The application during the runtime 52.47 Rotate Text The next example rotate text using a Timer. Load "guilib.ring" nAngle = 0 New qapp { win1 = new qwidget() { setwindowtitle("Rotate Text") resize(800,600) label1 = new qlabel(win1) { settext("") myfilter = new qallevents(win1) myfilter.setMouseButtonPressevent("pClick()") installeventfilter(myfilter) } new qtimer(win1) { setinterval(50) 52.47. Rotate Text 492
- 516. Ring Documentation, Release1.4.1 settimeoutevent("pTime()") start() } pDraw() L1 = new qVBoxLayout() { AddWidget(Label1) } SetLayout(L1) showMaximized() } exec() } Func pDraw p1 = new qpicture() color = new qcolor() { setrgb(0,0,255,255) } pen = new qpen() { setcolor(color) setwidth(50) } painter = new qpainter() { begin(p1) setpen(pen) myfont = font() myfont.setpointsize(50) setfont(myfont) rotate(nAngle) drawtext(350,0*nAngle,"welcome") drawtext(0,0*nAngle,"welcome") endpaint() } label1 { setpicture(p1) show() } Func pClick win1 { setwindowtitle("Click Event") } Func pTime nAngle++ if nAngle = 90 nAngle = 10 ok pDraw() The application during the runtime 52.47. Rotate Text 493
- 517. Ring Documentation, Release1.4.1 52.48 Change Focus The next example change the focus using the ENTER key. load "guilib.ring" new qApp { win = new qWidget() { resize(600,600) SetWindowTitle("Change Focus") text1 = new qLineEdit(win) text2 = new qLineEdit(win) text3 = new qLineEdit(win) text4 = new qLineEdit(win) layout1 = new qVBoxLayout() { AddWidget(text1) AddWidget(text2) AddWidget(text3) AddWidget(text4) } setLayout(Layout1) 52.48. Change Focus 494
- 518. Ring Documentation, Release1.4.1 aList = [text1,text2,text3,text4] oFilter = new qallevents(win) oFilter.setKeyPressEvent("pWork()") installeventfilter(oFilter) show() } exec() } func pWork nCode = oFilter.getkeycode() if nCode = 16777220 # ENTER Key for x=1 to len(aList) if aList[x].HasFocus() t = x+1 if t > len(aList) t=1 ok aList[t].SetFocus(0) exit ok next ok 52.49 Regular Expressions The next example uses the Regular Expressions classes. load "guilib.ring" new qApp { see "Using Regular Expressions" + nl exp = new qregularexpression() { setPattern("dd w+") see pattern() + nl match = match("33 one",0,0,0) see match.hasmatch() + nl match = match("3 one",0,0,0) see match.hasmatch() + nl match = match("welcome 11 one",0,0,0) see match.hasmatch() + nl matched = match.captured(0) see matched + nl } exp = new qregularexpression() { setPattern("^(dd)/(dd)/(dddd)$") see pattern() + nl match = match("08/12/1985",0,0,0) see match.hasmatch() + nl day = match.captured(1) month = match.captured(2) year = match.captured(3) see day + nl + month + nl + year + nl see "(" + match.capturedStart(1) + "," + match.capturedEnd(1)+ ")" + nl see "(" + match.capturedStart(2) + "," + match.capturedEnd(2)+ ")" + nl see "(" + match.capturedStart(3) + "," + match.capturedEnd(3)+ ")" + nl 52.49. Regular Expressions 495
- 519. Ring Documentation, Release1.4.1 } } Output Using Regular Expressions dd w+ 1 0 1 11 one ^(dd)/(dd)/(dddd)$ 1 08 12 1985 (0,2) (3,5) (6,10) 52.50 Simple Client and Server Example In this section we will learn about creating simple Client and Server Application Load "guilib.ring" new qApp { oClient = new Client { client() } oServer = new Server { server() } exec() } Class Client win1 lineedit1 cOutput="" oTcpSocket func client win1 = new qwidget() new qpushbutton(win1) { setgeometry(50,50,100,30) settext("connect") setclickevent("oClient.Connect()") } lineedit1 = new qtextedit(win1) { setGeometry(150,50,200,300) } win1 { setwindowtitle("client") setgeometry(10,100,400,400) show() 52.50. Simple Client and Server Example 496
- 520. Ring Documentation, Release1.4.1 } func connect cOutput = "Connect to host 127.0.0.1 port 9999" + nl lineedit1.settext(cOutput) oTcpSocket = new qTcpSocket(win1) { setconnectedevent("oClient.pConnected()") setreadyreadevent("oClient.pRead()") connecttohost("127.0.0.1",9999,3,0) waitforconnected(5000) } func pConnected cOutput += "Connected!" + nl lineedit1.settext(cOutput) func pRead cOutput += "Ready Read!" + nl lineedit1.settext(cOutput) cOutput += oTcpSocket.readall().data() + nl lineedit1.settext(cOutput) Class Server win1 lineedit1 oTcpServer oTcpClient cOutput = "" func server win1 = new qwidget() lineedit1 = new qtextedit(win1) { setGeometry(150,50,200,300) } win1 { setwindowtitle("Server") setgeometry(450,100,400,400) show() } oTcpServer = new qTcpServer(win1) { setNewConnectionEvent("oServer.pNewConnection()") oHostAddress = new qHostAddress() oHostAddress.SetAddress("127.0.0.1") listen(oHostAddress,9999) } cOutput = "Server Started" + nl + "listen to port 9999" + nl lineedit1.settext(cOutput) Func pNewConnection oTcpClient = oTcpServer.nextPendingConnection() 52.50. Simple Client and Server Example 497
- 521. Ring Documentation, Release1.4.1 cOutput += "Accept Connection" + nl lineedit1.settext(cOutput) oTcpClient { cStr ="Hello from server to client!"+char(13)+char(10) write(cStr,len(cStr)) flush() waitforbyteswritten(300000) close() } The application during the runtime 52.51 Dynamic Objects We may create objects in the runtime and add them to windows. Example: load "guilib.ring" oFormDesigner = new FormDesigner { start("oFormDesigner") } Class FormDesigner winToolBox winForm aObjects = [] func start cObjectName oApp = new qApp winToolBox = new qWidget() winToolBox.setWindowTitle("ToolBox") 52.51. Dynamic Objects 498
- 522. Ring Documentation, Release1.4.1 winToolBox.move(10,10) winToolBox.resize(300,600) btn = new qPushButton(winToolBox) btn.resize(300,30) btn.setText("Create Button") btn.setClickEvent(cObjectName+".pCreateButton()") btn.show() winToolBox.show() winForm = new qWidget() { move(400,50) setWindowTitle("Form Designer") resize(600,600) show() } oApp.exec() func pCreateButton nCount = len(aObjects) aObjects + new MyButton(winForm) { nIndex = nCount + 1 setText("Button"+ nIndex) Move(30*nIndex,30*nIndex) resize(100,30) show() } Class MyButton from qPushButton nIndex = 0 52.52 Weight History Application The next sample help in recording (Date, Time and Weight). Load "guilib.ring" MyApp = new qApp { $ApplicationObject = "oApp" # To be used when calling events oApp = new App exec() oApp.CloseDatabase() } class App cDir = currentdir() + "/" oCon 52.52. Weight History Application 499
- 523. Ring Documentation, Release1.4.1 aIDs = [] win1 = new qWidget() { setWindowTitle("Weight History") resize(600,600) layoutButtons = new qhboxlayout() { label1 = new qLabel(win1) { setText("Weight") } text1 = new qlineedit(win1) btnAdd = new qpushbutton(win1) { setText("Add") setClickEvent($ApplicationObject+".AddWeight()") } btnDelete = new qpushbutton(win1) { setText("Delete") setClickEvent($ApplicationObject+".Deleteweight()") } addwidget(label1) addwidget(text1) addwidget(btnAdd) addwidget(btnDelete) } layoutData = new qhboxlayout() { Table1 = new qTableWidget(win1) { setrowcount(0) setcolumncount(3) setselectionbehavior(QAbstractItemView_SelectRows) setHorizontalHeaderItem(0, new QTableWidgetItem("Date")) setHorizontalHeaderItem(1, new QTableWidgetItem("Time")) setHorizontalHeaderItem(2, new QTableWidgetItem("Weight")) setitemChangedEvent($ApplicationObject+".ItemChanged()") setAlternatingRowColors(true) horizontalHeader().setStyleSheet("color: blue") verticalHeader().setStyleSheet("color: red") } addWidget(Table1) } layoutClose = new qhboxlayout() { btnclose = new qpushbutton(win1) { setText("Close") setClickEvent("MyApp.Quit()") } addwidget(btnClose) } layoutMain = new qvboxlayout() { addlayout(layoutButtons) addLayout(LayoutData) addLayout(layoutClose) } setlayout(layoutMain) self.OpenDatabase() self.ShowRecords() show() } 52.52. Weight History Application 500
- 524. Ring Documentation, Release1.4.1 Func OpenDatabase lCreate = False if not fexists(cDir + "weighthistory.db") lCreate = True ok new QSqlDatabase() { this.oCon = addDatabase("QSQLITE") { setDatabaseName("weighthistory.db") Open() } } if lCreate new QSqlQuery( ) { exec("create table weighthistory (id integer primary key,"+ " f_date varchar(10),"+ " f_time varchar(8), f_weight varchar(8) );") delete() } ok Func CloseDatabase oCon.Close() Func AddWeight cWeight = text1.text() AddRecord(cWeight) Func DeleteWeight Table1 { nRow = CurrentRow() if nRow >= 0 nID = this.aIDs[nROW+1] new QSqlQuery( ) { exec("delete from weighthistory where id = " + nID ) } Del(this.aIDs,nRow+1) removerow(nRow) selectrow(nRow) ok } Func AddRecord cWeight new QSqlQuery( ) { cStr = "insert into weighthistory (f_date,f_time,f_weight) values"+ " ('%f1','%f2','%f3')" cDate = Date() cTime = Time() cStr = substr(cStr,"%f1",cDate) cStr = substr(cStr,"%f2",cTime) cStr = substr(cStr,"%f3",cWeight) exec(cStr) delete() } ShowRecords() Table1.selectrow(table1.rowcount()-1) 52.52. Weight History Application 501
- 525. Ring Documentation, Release1.4.1 Func ShowRecords table1.setitemChangedEvent("") aIDs = [] query = new QSqlQuery() { exec("select * from weighthistory") nRows = 0 this.Table1.setrowcount(0) while movenext() this.table1 { insertRow(nRows) this.aIDs + query.value(0).tostring() for x = 1 to 3 cStr = query.value(x).tostring() item = new qTableWidgetItem(cStr) setItem(nRows,x-1,item) next } nRows++ end delete() } table1.setitemChangedEvent($ApplicationObject+".ItemChanged()") Func ItemChanged nRow = table1.currentrow() if nRow >= 0 myitem = Table1.item(table1.currentrow(),0) cDate = myitem.text() myitem = Table1.item(table1.currentrow(),1) cTime = myitem.text() myitem = Table1.item(table1.currentrow(),2) cWeight = myitem.text() new QSqlQuery( ) { cStr = "update weighthistory set f_date ='%f1' , f_time = '%f2' , "+ "f_weight ='%f3' where id = " + this.aIDs[nROW+1] cStr = substr(cStr,"%f1",cDate) cStr = substr(cStr,"%f2",cTime) cStr = substr(cStr,"%f3",cWeight) exec(cStr) delete() } ok The next screen shot for the application during the runtime 52.52. Weight History Application 502
- 526. Ring Documentation, Release1.4.1 52.53 Notepad Application In the next example we will see simple Notepad developed using the RingQt Load "guilib.ring" cActiveFileName = "" aTextColor = [0,0,0] aBackColor = [255,255,255] cFont = "MS Shell Dlg 2,14,-1,5,50,0,0,0,0,0" cWebsite = "http://www.google.com" 52.53. Notepad Application 503
- 527. Ring Documentation, Release1.4.1 oSearch = NULL oSearchValue = NULL oSearchCase = NULL oSearchFilter = NULL oReplaceValue = NULL lAskToSave = false MyApp = New qApp { win1 = new qMainWindow() { setwindowtitle("Ring Notepad") setGeometry(100,100,400,400) aBtns = [ new qpushbutton(win1) { setbtnimage(self,"image/new.png") setclickevent("pNew()") settooltip("New File") } , new qpushbutton(win1) { setbtnimage(self,"image/open.png") setclickevent("pOpen()") settooltip("Open File") } , new qpushbutton(win1) { setbtnimage(self,"image/save.png") setclickevent("pSave()") settooltip("Save") } , new qpushbutton(win1) { setbtnimage(self,"image/saveas.png") setclickevent("pSaveAs()") settooltip("Save As") } , new qpushbutton(win1) { setbtnimage(self,"image/cut.png") setclickevent("pCut()") settooltip("Cut") } , new qpushbutton(win1) { setbtnimage(self,"image/copy.png") setclickevent("pCopy()") settooltip("Copy") } , new qpushbutton(win1) { setbtnimage(self,"image/paste.png") setclickevent("pPaste()") settooltip("Paste") } , new qpushbutton(win1) { setbtnimage(self,"image/font.png") setclickevent("pFont()") settooltip("Font") } , new qpushbutton(win1) { setbtnimage(self,"image/colors.jpg") setclickevent("pColor()") settooltip("Text Color") 52.53. Notepad Application 504
- 528. Ring Documentation, Release1.4.1 } , new qpushbutton(win1) { setbtnimage(self,"image/search.png") setclickevent("pFind()") settooltip("Find and Replace") } , new qpushbutton(win1) { setbtnimage(self,"image/print.png") setclickevent("pPrint()") settooltip("Print") } , new qpushbutton(win1) { setbtnimage(self,"image/debug.png") setclickevent("pDebug()") settooltip("Debug (Run then wait!)") } , new qpushbutton(win1) { setbtnimage(self,"image/run.png") setclickevent("pRun()") settooltip("Run the program") } , new qpushbutton(win1) { setbtnimage(self,"image/close.png") setclickevent("pQuit()") settooltip("Quit") } ] tool1 = addtoolbar("files") { for x in aBtns addwidget(x) addseparator() next } menu1 = new qmenubar(win1) { sub1 = addmenu("File") sub2 = addmenu("Edit") sub3 = addmenu("View") sub4 = addmenu("Help") sub1 { oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+n")) setbtnimage(self,"image/new.png") settext("New") setclickevent("pNew()") } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+o")) setbtnimage(self,"image/open.png") settext("Open") setclickevent("pOpen()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+s")) setbtnimage(self,"image/save.png") settext("Save") setclickevent("pSave()") 52.53. Notepad Application 505
- 529. Ring Documentation, Release1.4.1 } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+e")) setbtnimage(self,"image/saveas.png") settext("Save As") setclickevent("pSaveAs()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+p")) setbtnimage(self,"image/print.png") settext("Print to PDF") setclickevent("pPrint()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+d")) setbtnimage(self,"image/debug.png") settext("Debug (Run then wait!)") setclickevent("pDebug()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+r")) setbtnimage(self,"image/run.png") settext("Run") setclickevent("pRun()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+F5")) setbtnimage(self,"image/run.png") settext("Run GUI Application (No Console)") setclickevent("pRunNoConsole()") } addaction(oAction) addseparator() oAction = new qaction(win1) { setShortcut(new QKeySequence("Ctrl+q")) setbtnimage(self,"image/close.png") settext("Exit") setstatustip("Exit") setclickevent("pQuit()") } addaction(oAction) } sub2 { oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+x")) setbtnimage(self,"image/cut.png") settext("Cut") setclickevent("pCut()") 52.53. Notepad Application 506
- 530. Ring Documentation, Release1.4.1 } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+c")) setbtnimage(self,"image/copy.png") settext("Copy") setclickevent("pCopy()") } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+v")) setbtnimage(self,"image/paste.png") settext("Paste") setclickevent("pPaste()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+i")) setbtnimage(self,"image/font.png") settext("Font") setclickevent("pFont()") } addseparator() addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+t")) setbtnimage(self,"image/colors.jpg") settext("Text Color") setclickevent("pColor()") } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+b")) setbtnimage(self,"image/colors.jpg") settext("Back Color") setclickevent("pColor2()") } addaction(oAction) addseparator() oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+g")) settext("Go to line") setclickevent("pGoto()") } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+f")) setbtnimage(self,"image/search.png") settext("Find and Replace") setclickevent("pFind()") } addaction(oAction) } sub3 { oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+p")) setbtnimage(self,"image/project.png") 52.53. Notepad Application 507
- 531. Ring Documentation, Release1.4.1 settext("Project Files") setclickevent("pProject()") } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+u")) setbtnimage(self,"image/source.png") setclickevent("pSourceCode()") settext("Source Code") } addaction(oAction) oAction = new qAction(win1) { setShortcut(new QKeySequence("Ctrl+w")) setbtnimage(self,"image/richtext.png") setclickevent("pWebBrowser()") settext("Web Browser") } addaction(oAction) } sub4 { sub5 = addmenu("Development Tools") sub5 { oAction = new qAction(win1) { settext("Programming Language") setclickevent("pLang()") } addaction(oAction) oAction = new qAction(win1) { settext("GUI Library") setclickevent("pGUI()") } addaction(oAction) } addseparator() oAction = new qAction(win1) { settext("About") setclickevent("pAbout()") } addaction(oAction) } } setmenubar(menu1) status1 = new qstatusbar(win1) { showmessage("Ready!",0) } setstatusbar(status1) tree1 = new qtreeview(win1) { setclickedevent("pChangeFile()") setGeometry(00,00,200,400) oDir = new QDir() ofile = new QFileSystemModel() { setrootpath(oDir.currentpath()) myfiles = new qstringlist() 52.53. Notepad Application 508
- 532. Ring Documentation, Release1.4.1 myfiles.append("*.ring") myfiles.append("*.rh") setnamefilters(myfiles) setNameFilterDisables(false) } setmodel(ofile) myindex = ofile.index(oDir.currentpath(),0) for x = 1 to ofile.columncount() hidecolumn(x) next setcurrentindex(myindex) setexpanded(myindex,true) header().hide() } oDock1 = new qdockwidget(win1,0) { setGeometry(00,00,200,200) setwindowtitle("Project Files") setwidget(tree1) } textedit1 = new qtextedit(win1) { setCursorPositionChangedevent("pCursorPositionChanged()") setLineWrapMode(QTextEdit_NoWrap) setAcceptRichText(false) setTextChangedEvent("lAskToSave = true") } oDock2 = new qdockwidget(win1,0) { setwidget(textedit1) setwindowtitle("Source Code") } oWebBrowser = new qWidget() { setWindowFlags(Qt_SubWindow) oWBLabel = new qLabel(win1) { setText("Website: ") } oWBText = new qLineEdit(win1) { setText(cWebSite) setReturnPressedEvent("pWebGo()") } oWBGo = new qPushButton(win1) { setText("Go") setClickEvent("pWebGo()") } oWBBack = new qPushButton(win1) { setText("Back") setClickEvent("pWebBack()") } oWBLayout1 = new qHBoxLayout() { addWidget(oWBLabel) addWidget(oWBText) addWidget(oWBGo) addWidget(oWBBack) } oWebView = new qWebView(win1) { 52.53. Notepad Application 509
- 533. Ring Documentation, Release1.4.1 loadpage(new qurl(cWebSite)) } oWBlayout2 = new qVBoxLayout() { addLayout(oWBLayout1) addWidget(oWebView) } setLayout(oWBLayout2) } oDock3 = new qdockwidget(win1,0) { setwidget(oWebBrowser) setwindowtitle("Web Browser") setFeatures(QDockWidget_DocWidgetClosable) } adddockwidget(1,oDock1,1) adddockwidget(2,oDock2,2) adddockwidget(2,oDock3,1) setwinicon(self,"image/notepad.png") showmaximized() } RestoreSettings() exec() } func pWebGo cWebsite = oWBText.text() oWebView.LoadPage( new qurl( cWebSite ) ) func pWebBack oWebView.Back() func pProject oDock1.Show() func pSourceCode oDock2.Show() func pWebBrowser oDock3.Show() func pChangeFile myitem = tree1.currentindex() if ofile.isdir(myitem) return ok cActiveFileName = ofile.filepath(myitem) textedit1.settext(read(cActiveFileName)) textedit1.setfocus(0) pCursorPositionChanged() pSetActiveFileName() func pSetActiveFileName oDock2.setWindowTitle("Source Code : " + cActiveFileName) func pCursorPositionChanged 52.53. Notepad Application 510
- 534. Ring Documentation, Release1.4.1 status1.showmessage(" Line : "+(textedit1.textcursor().blocknumber()+1)+ " Column : " +(textedit1.textcursor().columnnumber()+1) + " Total Lines : " + textedit1.document().linecount() ,0) func pGoto oInput = New QInputDialog(win1) { setwindowtitle("Enter the line number?") setgeometry(100,100,400,50) setlabeltext("Line") settextvalue("1") exec() nLine = 0 + oInput.textvalue() oBlock = textedit1.document().findBlockByLineNumber(nLine-1) oCursor = textedit1.textcursor() oCursor.setposition(oBlock.position(),0) textedit1.settextcursor(oCursor) } func pFind if isobject(oSearch) oSearch.activatewindow() return ok oSearch = new qWidget() { new qLabel(oSearch) { setText("Find What : ") setgeometry(10,10,50,30) } oSearchValue = new qlineedit(oSearch) { setgeometry(80,10,460,30) setReturnPressedEvent("pFindValue()") } new qLabel(oSearch) { setText("Replace with ") setgeometry(10,45,80,30) } oReplaceValue = new qlineedit(oSearch) { setgeometry(80,45,460,30) } oSearchCase = new qCheckbox(oSearch) { setText("Case Sensitive") setgeometry(80,85,100,30) } new qPushButton(oSearch) { setText("Find/Find Next") setgeometry(80,120,100,30) setclickevent("pFindValue()") } new qPushButton(oSearch) { 52.53. Notepad Application 511
- 535. Ring Documentation, Release1.4.1 setText("Replace") setgeometry(200,120,100,30) setclickevent("pReplace()") } new qPushButton(oSearch) { setText("Replace All") setgeometry(320,120,100,30) setclickevent("pReplaceAll()") } new qPushButton(oSearch) { setText("Close") setgeometry(440,120,100,30) setclickevent("pSearchClose()") } setwinicon(oSearch,"image/notepad.png") setWindowTitle("Find/Replace") setStyleSheet("background-color:white;") setFixedsize(550,160) setwindowflags( Qt_CustomizeWindowHint | Qt_WindowTitleHint | Qt_WindowStaysOnTopHint) oSearchFilter = new qallevents(oSearch) oSearchFilter.setKeyPressEvent("pSearchKeyPress()") installeventfilter(oSearchFilter) show() } Func pReplace oCursor = textedit1.textCursor() if oCursor.HasSelection() = false new qMessagebox(oSearch) { SetWindowTitle("Replace") SetText("No Selection") show() } return false ok cValue = oSearchValue.text() cSelected = oCursor.SelectedText() if oSearchCase.checkState() = Qt_Unchecked cValue = lower(cValue) cSelected = lower(cSelected) ok if cSelected != cValue new qMessagebox(oSearch) { SetWindowTitle("Replace") SetText("No Match") show() } return false ok cValue = oReplaceValue.text() 52.53. Notepad Application 512
- 536. Ring Documentation, Release1.4.1 nStart = oCursor.SelectionStart() nEnd = oCursor.SelectionEnd() cStr = textedit1.toPlainText() cStr = left(cStr,nStart)+cValue+substr(cStr,nEnd+1) textedit1.setText(cStr) return pFindValue() Func pReplaceAll cStr = textedit1.toPlainText() cOldValue = oSearchValue.text() cNewValue = oReplaceValue.text() if oSearchCase.checkState() = Qt_Unchecked # Not Case Sensitive cStr = SubStr(cStr,cOldValue,cNewValue,true) else # Case Sensitive cStr = SubStr(cStr,cOldValue,cNewValue) ok textedit1.setText(cStr) new qMessagebox(oSearch) { SetWindowTitle("Replace All") SetText("Operation Done") show() } Func pSearchClose oSearch.close() oSearch = NULL func pSearchKeyPress if oSearchFilter.getKeyCode() = Qt_Key_Escape pSearchClose() ok func pFindValue oCursor = textedit1.textcursor() nPosStart = oCursor.Position() + 1 cValue = oSearchValue.text() cStr = textedit1.toplaintext() cStr = substr(cStr,nPosStart) if oSearchCase.checkState() = Qt_Unchecked cStr = lower(cStr) cValue = lower(cValue) ok nPos = substr(cStr,cValue) if nPos > 0 nPos += nPosStart - 2 oCursor = textedit1.textcursor() oCursor.setposition(nPos,0) textedit1.settextcursor(oCursor) oCursor = textedit1.textcursor() oCursor.setposition(nPos+len(cValue),1) textedit1.settextcursor(oCursor) return true else new qMessagebox(oSearch) { SetWindowTitle("Search") 52.53. Notepad Application 513
- 537. Ring Documentation, Release1.4.1 SetText("Cannot find :" + cValue) show() } return false ok func pNofileopened New qMessageBox(win1) { setWindowTitle("Sorry") setText("Save the file first!") show() } func pDebug if cActiveFileName = Null return pNofileopened() ok cCode = "start run " + cActiveFileName + nl system(cCode) func pRun if cActiveFileName = Null return pNofileopened() ok cCode = "start ring " + cActiveFileName + nl system(cCode) func pRunNoConsole if cActiveFileName = Null return pNofileopened() ok cCode = "start /b ring " + cActiveFileName + nl system(cCode) func pSave if cActiveFileName = NULL return pSaveAs() ok writefile(cActiveFileName,textedit1.toplaintext()) status1.showmessage("File : " + cActiveFileName + " saved!",0) lAskToSave = false func pSaveAs new qfiledialog(win1) { cName = getsavefilename(win1,"Save As","","source files(*.ring)") if cName != NULL cActiveFileName = cName writefile(cActiveFileName,textedit1.toplaintext()) status1.showmessage("File : " + cActiveFileName + " saved!",0) pSetActiveFileName() lAskToSave = false ok } func pPrint status1.showmessage("Printing to File : RingDoc.pdf",0) printer1 = new qPrinter(0) { setoutputformat(1) # 1 = pdf setoutputfilename("RingDoc.pdf") textedit1.print(printer1) } status1.showmessage("Done!",0) system("RingDoc.pdf") func pCut textedit1.cut() 52.53. Notepad Application 514
- 538. Ring Documentation, Release1.4.1 status1.showmessage("Cut!",0) func pCopy textedit1.copy() status1.showmessage("Copy!",0) func pPaste textedit1.paste() status1.showmessage("Paste!",0) func pFont oFontDialog = new qfontdialog() { aFont = getfont() } textedit1.selectall() cFont = aFont[1] pSetFont() Func pSetFont myfont = new qfont("",0,0,0) myfont.fromstring(cFont) textedit1.setcurrentfont(myfont) Func pColor new qcolordialog() { aTextColor = GetColor() } pSetColors() Func pColor2 new qcolordialog() { aBackColor = GetColor() } pSetColors() Func pSetColors textedit1.setstylesheet("color: rgb(" + aTextColor[1] + "," + aTextColor[2] + "," + aTextColor[3] + ");" + "background-color: rgb(" + aBackColor[1] + "," + aBackColor[2] + "," + aBackColor[3] + ")") func pOpen new qfiledialog(win1) { cName = getopenfilename(win1,"open file","c:","source files(*.ring)") if cName != NULL cActiveFileName = cName textedit1.settext(read(cActiveFileName)) ok } func pNew new qfiledialog(win1) { cName = getsavefilename(win1,"New file","","source files(*.ring)") if cName != NULL write(cName,"") cActiveFileName = cName textedit1.settext(read(cActiveFileName)) ok } Func WriteFile cFileName,cCode 52.53. Notepad Application 515
- 539. Ring Documentation, Release1.4.1 aCode = str2list(cCode) fp = fopen(cFileName,"wb") for cLine in aCode fwrite(fp,cLine+char(13)+char(10)) next fclose(fp) Func MsgBox cTitle,cMessage new qMessagebox(win1) { setwindowtitle(cTitle) setText(cMessage) show() } Func pLang MsgBox("Programming Language", "This application developed using the Ring programming language") Func pGUI MsgBox("GUI Library", "This application uses the Qt GUI Library through RingQt") Func pAbout MsgBox("About", "2016, Mahmoud Fayed <msfclipper@yahoo.com>") Func pSaveSettings cSettings = "aTextColor = ["+aTextColor[1]+","+aTextColor[2]+ ","+aTextColor[3]+"]" + nl + "aBackColor = ["+aBackColor[1]+","+aBackColor[2]+ ","+aBackColor[3]+"]" + nl + "cFont = '" + cFont + "'" + nl + "cWebSite = '" + cWebsite + "'" + nl cSettings = substr(cSettings,nl,char(13)+char(10)) write("ringnotepad.ini",cSettings) if lAsktoSave new qmessagebox(win1) { setwindowtitle("Save Changes?") settext("Some changes are not saved!") setInformativeText("Do you want to save your changes?") setstandardbuttons(QMessageBox_Yes | QMessageBox_No | QMessageBox_Cancel) result = exec() win1 { if result = QMessageBox_Yes pSave() but result = QMessageBox_Cancel return false ok } } ok return true Func pSetWebsite oWebView { loadpage(new qurl(cWebSite)) } 52.53. Notepad Application 516
- 540. Ring Documentation, Release1.4.1 oWBText { setText(cWebSite) } Func RestoreSettings eval(read("ringnotepad.ini")) pSetColors() pSetFont() pSetWebsite() Func pQuit if pSaveSettings() myapp.quit() ok The application during the runtime The next screen shot demonstrates the “File” menu The next window for “search and replace” The next screen shot demonstrates the application main window 52.53. Notepad Application 517
- 541. Ring Documentation, Release1.4.1 Note: the functions pDebug(), pRun() and pRunNoConsole() in the previous sample are not portable! They are written in this sample for MS-Windows and we can update them for other operating systems. 52.54 The Cards Game In the next example we will see a simple Cards game developed using RingQt Each player get 5 cards, the cards are unknown to any one. each time one player click on one card to see it. if the card is identical to another card the play get point for each card. if the card value is “5” the player get points for all visible cards. Load "guilib.ring" nScale = 1 app1 = new qApp mypic = new QPixmap("cards.jpg") mypic2 = mypic.copy(0,(124*4)+1,79,124) Player1EatPic = mypic.copy(80,(124*4)+1,79,124) Player2EatPic= mypic.copy(160,(124*4)+1,79,124) aMyCards = [] aMyValues = [] for x1 = 0 to 3 for y1 = 0 to 12 temppic = mypic.copy((79*y1)+1,(124*x1)+1,79,124) aMyCards + temppic aMyValues + (y1+1) next next 52.54. The Cards Game 518
- 542. Ring Documentation, Release1.4.1 nPlayer1Score = 0 nPlayer2Score=0 do Page1 = new Game Page1.Start() again Page1.lnewgame mypic.delete() mypic2.delete() Player1EatPic.delete() Player2EatPic.delete() for t in aMyCards t.delete() next func gui_setbtnpixmap pBtn,pPixmap pBtn { setIcon(new qicon(pPixmap.scaled(width(),height(),0,0))) setIconSize(new QSize(width(),height())) } Class Game nCardsCount = 10 win1 layout1 label1 label2 layout2 layout3 aBtns aBtns2 aCards nRole=1 aStatus = list(nCardsCount) aStatus2 = aStatus aValues aStatusValues = aStatus aStatusValues2 = aStatus Player1EatPic Player2EatPic lnewgame = false nDelayEat = 0.5 nDelayNewGame = 1 func start win1 = new qWidget() { setwindowtitle("Five") setstylesheet("background-color: White") showfullscreen() } layout1 = new qvboxlayout() label1 = new qlabel(win1) { settext("Player (1) - Score : " + nPlayer1Score) setalignment(Qt_AlignHCenter | Qt_AlignVCenter) setstylesheet("color: White; background-color: Purple; font-size:20pt") setfixedheight(200) } closebtn = new qpushbutton(win1) { settext("Close Application") setstylesheet("font-size: 18px ; color : white ; background-color: black ;") setclickevent("Page1.win1.close()") } 52.54. The Cards Game 519
- 543. Ring Documentation, Release1.4.1 aCards = aMyCards aValues = aMyValues layout2 = new qhboxlayout() aBtns = [] for x = 1 to nCardsCount aBtns + new qpushbutton(win1) aBtns[x].setfixedwidth(79*nScale) aBtns[x].setfixedheight(124*nScale) gui_setbtnpixmap(aBtns[x],mypic2) layout2.addwidget(aBtns[x]) aBtns[x].setclickevent("Page1.Player1click("+x+")") next layout1.addwidget(label1) layout1.addlayout(layout2) label2 = new qlabel(win1) { settext("Player (2) - Score : " + nPlayer2Score) setalignment(Qt_AlignHCenter | Qt_AlignVCenter) setstylesheet("color: white; background-color: red; font-size:20pt") setfixedheight(200) } layout3 = new qhboxlayout() aBtns2 = [] for x = 1 to nCardsCount aBtns2 + new qpushbutton(win1) aBtns2[x].setfixedwidth(79*nScale) aBtns2[x].setfixedheight(124*nScale) gui_setbtnpixmap(aBtns2[x],mypic2) layout3.addwidget(aBtns2[x]) aBtns2[x].setclickevent("Page1.Player2click("+x+")") next layout1.addwidget(label2) layout1.addlayout(layout3) layout1.addwidget(closebtn) win1.setlayout(layout1) app1.exec() Func Player1Click x if nRole = 1 and aStatus[x] = 0 nPos = ((random(100)+clock())%(len(aCards)-1)) + 1 gui_setbtnpixmap(aBtns[x],aCards[nPos]) del(aCards,nPos) nRole = 2 aStatus[x] = 1 aStatusValues[x] = aValues[nPos] del(aValues,nPos) Player1Eat(x,aStatusValues[x]) checknewgame() 52.54. The Cards Game 520
- 544. Ring Documentation, Release1.4.1 ok Func Player2Click x if nRole = 2 and aStatus2[x] = 0 nPos = ((random(100)+clock())%(len(aCards)-1)) + 1 gui_setbtnpixmap(aBtns2[x],aCards[nPos]) del(aCards,nPos) nRole = 1 aStatus2[x] = 1 aStatusValues2[x] = aValues[nPos] del(aValues,nPos) Player2Eat(x,aStatusValues2[x]) checknewgame() ok Func Player1Eat nPos,nValue app1.processEvents() delay(nDelayEat) lEat = false for x = 1 to nCardsCount if aStatus2[x] = 1 and (aStatusValues2[x] = nValue or nValue=5) aStatus2[x] = 2 gui_setbtnpixmap(aBtns2[x],Player1EatPic) lEat = True nPlayer1Score++ ok if (x != nPos) and (aStatus[x] = 1) and (aStatusValues[x] = nValue or nValue=5) aStatus[x] = 2 gui_setbtnpixmap(aBtns[x],Player1EatPic) lEat = True nPlayer1Score++ ok next if lEat nPlayer1Score++ gui_setbtnpixmap(aBtns[nPos],Player1EatPic) aStatus[nPos] = 2 label1.settext("Player (1) - Score : " + nPlayer1Score) ok Func Player2Eat nPos,nValue app1.processEvents() delay(nDelayEat) lEat = false for x = 1 to nCardsCount if aStatus[x] = 1 and (aStatusValues[x] = nValue or nValue = 5) aStatus[x] = 2 gui_setbtnpixmap(aBtns[x],Player2EatPic) lEat = True nPlayer2Score++ ok if (x != nPos) and (aStatus2[x] = 1) and 52.54. The Cards Game 521
- 545. Ring Documentation, Release1.4.1 (aStatusValues2[x] = nValue or nValue=5 ) aStatus2[x] = 2 gui_setbtnpixmap(aBtns2[x],Player2EatPic) lEat = True nPlayer2Score++ ok next if lEat nPlayer2Score++ gui_setbtnpixmap(aBtns2[nPos],Player2EatPic) aStatus2[nPos] = 2 label2.settext("Player (2) - Score : " + nPlayer2Score) ok Func checknewgame if isnewgame() lnewgame = true if nPlayer1Score > nPlayer2Score label1.settext("Player (1) Wins!!!") ok if nPlayer2Score > nPlayer1Score label2.settext("Player (2) Wins!!!") ok app1.processEvents() delay(nDelayNewGame) win1.delete() app1.quit() ok Func isnewgame for t in aStatus if t = 0 return false ok next for t in aStatus2 if t = 0 return false ok next return true Func delay x nTime = x * 1000 oTest = new qTest oTest.qsleep(nTime) The application during the runtime 52.54. The Cards Game 522
- 546. Ring Documentation, Release1.4.1 Note: in the previous screen shot the player get the card number ‘5’ but his score is not increased because he opened this card while no other cards are visible! The next screen shot while running the game using a Mobile (Android) 52.54. The Cards Game 523
- 547. Ring Documentation, Release1.4.1 Note: using Qt we can run the same application on other Mobile systems 52.55 Classes and their Methods to use the default events The next table present the class name and the methods that we have to use the default events. Class Name Methods to use the default Events QPushButton SetClickEvent() QAction SetClickEvent() QLineEdit SetTextChangedEvent() SetCursorPositionChangedEvent() SetEditingFinishedEvent() SetReturnPressedEvent() SetSelectionChangedEvent() SetTextEditedEvent() QTextEdit SetCopyAvailableEvent() SetCurrentCharFormatChangedEvent() SetCursorPositionChangedEvent() SetRedoAvailableEvent() Continued on next page 52.55. Classes and their Methods to use the default events 524
- 548. Ring Documentation, Release1.4.1 Table 52.1 – continued from previous page Class Name Methods to use the default Events SetSelectionChangedEvent() SetTextChangedEvent() SetUndoAvailableEvent() QListWidget SetCurrentItemChangedEvent() SetCurrentRowChangedEvent() SetCurrentTextChangedEvent() SetItemActivatedEvent() SetItemChangedEvent() SetItemClickedEvent() SetItemDoubleClickedEvent() SetItemEnteredEvent() SetItemPressedEvent() SetItemSelectionChangedEvent() QTreeView SetCollapseEvent() SetExpandedEvent() SetActivatedEvent() SetClickedEvent() SetDoubleClickedEvent() SetEnteredEvent() SetPressedEvent() SetViewportEnteredEvent() QTreeWidget SetCollapsedEvent() SetExpandedEvent() SetActivatedEvent() SetClickedEvent() SetDoubleClickedEvent() SetEnteredEvent() SetPressedEvent() SetViewportEnteredEvent() SetCurrentItemChangedEvent() SetItemActivatedEvent() SetItemChangedEvent() SetItemClickedEvent() SetItemCollapsedEvent() SetItemDoubleClickedEvent() SetItemEnteredEvent() SetItemExpandedEvent() SetItemPressedEvent() SetItemSelectionChangedEvent() QComboBox SetActivatedEvent() SetCurrentIndexChangedEvent() SetEditTextChangedEvent() SetHighlightedEvent() QTabWidget SetCurrentChangedEvent() SetTabCloseRequestedEvent() QTableWidget SetCellActivatedEvent() SetCellChangedEvent() SetCellClickedEvent() SetCellDoubleClickedEvent() Continued on next page 52.55. Classes and their Methods to use the default events 525
- 549. Ring Documentation, Release1.4.1 Table 52.1 – continued from previous page Class Name Methods to use the default Events SetCellEnteredEvent() SetCellPressedEvent() SetCurrentCellChangedEvent() SetCurrentItemChangedEvent() SetItemActivatedEvent() SetItemChangedEvent() SetItemClickedEvent() SetItemDoubleClickedEvent() SetItemEnteredEvent() SetItemPressedEvent() SetItemSelectionChangedEvent() QProgressBar SetValueChangedEvent() QSpinBox SetValueChangedEvent() QSlider SetActionTriggeredEvent() SetRangeChangedEvent() SetSliderMovedEvent() SetSliderPressedEvent() SetSliderReleasedEvent() SetValueChangedEvent() QDial SetActionTriggeredEvent() SetRangeChangedEvent() SetSliderMovedEvent() SetSliderPressedEvent() SetSliderReleasedEvent() SetValueChangedEvent() QWebView SetLoadFinishedEvent() SetLoadProgressEvent() SetLoadStartedEvent() SetSelectionChangedEvent() SetTitleChangedEvent() SetUrlChangedEvent() QCheckBox SetStateChangedEvent() SetClickedEvent() SetPressedEvent() SetReleasedEvent() SetToggledEvent() QRadioButton SetClickedEvent() SetPressedEvent() SetReleasedEvent() SetToggledEvent() QButtonGroup SetButtonClickedEvent() SetButtonPressedEvent() SetButtonReleasedEvent() QVideoWidget SetBrightnessChangedEvent() SetContrastChangedEvent() SetFullScreenChangedEvent() SetHueChangedEvent() SetSaturationChangedEvent() QTimer SetTimeoutEvent() Continued on next page 52.55. Classes and their Methods to use the default events 526
- 550. Ring Documentation, Release1.4.1 Table 52.1 – continued from previous page Class Name Methods to use the default Events QTcpServer SetAcceptErrorEvent() SetNewConnectionEvent() QIODevice SetAboutToCloseEvent() SetBytesWrittenEvent() SetReadChannelFinishedEvent() SetReadyReadEvent() QAbstractSocket SetConnectedEvent() SetDisconnectedEvent() SetErrorEvent() SetHostFoundEvent() SetProxyAuthenticationRequiredEvent() SetStateChangedEvent() QTcpSocket SetConnectedEvent() SetDisconnectedEvent() SetErrorEvent() SetHostFoundEvent() SetProxyAuthenticationRequiredEvent() SetStateChangedEvent() SetAboutToCloseEvent() SetBytesWrittenEvent() SetReadChannelFinishedEvent() SetReadyReadEvent() QColorDialog SetColorSelectedEvent() SetCurrentColorChangedEvent() QNetworkAccessManager SetFinishedEvent() QThread SetStartedEvent() SetFinishedEvent() 52.56 Methods to use Events with Events Filter RingQt define a new class called QAllEvents that help you in using Events Filter The next table presents the methods that we have Methods to get parameters Class Name getKeyCode() –> Number QAllEvents getx() –> Number gety() –> Number getglobalx() –> Number getglobaly() –> Number getbutton() –> Number getbuttons() –> Number The next table presents the methods that we have to use events. 52.56. Methods to use Events with Events Filter 527
- 551. Ring Documentation, Release1.4.1 Method Name Class Name setKeyPressEvent(cEvent) QAllEvents setMouseButtonPressEvent(cEvent) setMouseButtonReleaseEvent(cEvent) setMouseButtonDblClickEvent(cEvent) setMouseMoveEvent(cEvent) setCloseEvent(cEvent) setContextMenuEvent(cEvent) setDragEnterEvent(cEvent) setDragLeaveEvent(cEvent) setDragMoveEvent(cEvent) setDropEvent(cEvent) setEnterEvent(cEvent) setFocusInEvent(cEvent) setFocusOutEvent(cEvent) setKeyReleaseEvent(cEvent) setLeaveEvent(cEvent) setNonClientAreaMouseButtonDblClickEvent(cEvent) setNonClientAreaMouseButtonPressEvent(cEvent) setNonClientAreaMouseButtonReleaseEvent(cEvent) setNonClientAreaMouseMoveEvent(cEvent) setMoveEvent(cEvent) setResizeEvent(cEvent) setWindowActivateEvent(cEvent) setWindowBlockedEvent(cEvent) setWindowDeactivateEvent(cEvent) setWindowStateChangeEvent(cEvent) setWindowUnblockedEvent(cEvent) 52.57 The Difference between Qt and RingQt 1. RingQt use simple methods to set the code that will be executed for events. Syntax: Set<Event_Name>Event(cEventCode) 2. RingQt change the name of some methods to avoid conflict with Ring Keywords. The next table present these little changes 52.57. The Difference between Qt and RingQt 528
- 552. Ring Documentation, Release1.4.1 Class Name Qt Method Name RingQt Method Name QWebView load loadpage QMediaPlaylist load loadfile QMediaPlaylist next movenext QPainter end endpaint QPicture load loadfile QLineEdit end endtext QDialog done donedialog QTextDocument end enddoc QTextBlock next nextblock QSqlQuery next movenext QImage load loadimage QNetworkAccessManager get getvalue QNetworkAccessManager put putvalue QThread exit exitfromthread QRegularExpressionMatchIterator next nextitem QCamera load loadcamera 52.58 RingQt Classes and their Qt Documentation Qt Documentation : http://doc.qt.io/qt-5/classes.html See the “RingQt Classes and Methods Reference” chapter for supported classes and methods. 52.59 New Classes names - Index Start from 1 We added new classes to RingQt - another version of classes where the class names doesn’t start with the “q” letter Also updated methods so the index start from 1 when we deal with the GUI controls like • ComboBox • ListWidget • TableWidget • TreeWidget These classes are inside guilib.ring under the package name : System.GUI To use it load "guilib.ring" import System.GUI This doesn’t have any effect on our previous code, It’s just another choice for better code that is consistent with Ring rules. Also the form designer is updated to provide us the choice between using classes where (index start from 0) or (index start from 1) Example (Uses the Form Designer) 1. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/indexstart/indexstartView.ring 2. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/indexstart/indexstartController.ring 52.58. RingQt Classes and their Qt Documentation 529
- 553. CHAPTER FIFTYTHREE BUILDING RINGQT APPLICATIONSFOR MOBILE In this chapter we will learn about Building RingQt Applications for Mobile. 53.1 Download Requirements Check the next link : http://doc.qt.io/qt-5/androidgs.html Download • The Android SDK Tools https://developer.android.com/studio/index.html • The Android NDK https://developer.android.com/ndk/index.html • Apache Ant v1.8 or later http://ant.apache.org/bindownload.cgi • Java SE Development Kit (JDK) v6 or later http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html 53.2 Update the Android SDK Update the Android SDK to get the API and tools packages required for development 53.3 Install Qt for Android • You can install Qt for Android from the next link https://download.qt.io/archive/qt/5.5/5.5.1/ • Run Qt Creator, Select Tools > Options > Android to add the Android NDK and SDK paths. http://doc.qt.io/qtcreator/creator-developing-android.html • Using Qt Creator Open the project Folder : ring/android/ringqt/project Project file : project.pro 530
- 554. Ring Documentation, Release1.4.1 • You will find the code in resourcestest.ring You can modify the code then build and run for Desktop or Mobile. 53.4 Comments about developing for Android using RingQt 1. The main project file is main.cpp This file load Ring Compiler/Virtual Machine and RingQt Then copy files during the runtime from the resources to temp. folder Then run the test.ring Through main.cpp you can extract more files from the resources to temp. folder once you add them (create projects with many files). 2. The next functions are missing from this Ring edition • Database (ODBC, SQLite & MySQL) • Security and Internet functions (LibCurl & OpenSSL) • RingAllegro (Allegro Library) • RingLibSDL (LibSDL Library) Just use Qt Classes through RingQt. For database access use the QSqlDatabase Class Note: All of the missing libraries ((LibCurl, OpenSSL & Allegro) can be compiled for Android, but they are not included in this Qt project. 3. use if isandroid() when you want to modify the code just for android 53.4. Comments about developing for Android using RingQt 531
- 555. Ring Documentation, Release1.4.1 Example: if isandroid() // Android code else // other platforms ok (4) Sometimes you will find that the button text/image is repeated in drawing ! it’s Qt problem that you can avoid using the next code. if isandroid() setStyleSheet(" border-style: outset; border-width: 2px; border-radius: 4px; border-color: black; padding: 6px;") ok 5. Always use Layouts instead of manual setting of controls position and size. This is the best way to get the expected user interface to avoid problems like (controls with small/extra size) 6. When you deal with Qt Classes you can determine the images from resources (you don’t need to copy them using main.cpp) Example: if isandroid() mypic = new QPixmap(":/resources/cardsimage") else mypic = new QPixmap("cards.jpg") ok In the previous example, cards.jpg is added to the resources then we write the “cardsimage” as alias for “cards.jpg” 53.4. Comments about developing for Android using RingQt 532
- 556. CHAPTER FIFTYFOUR OBJECTS LIBRARY FORRINGQT APPLICATION In this chapter we will learn about the objects library for RingQt applications. Ring comes with the Objects library for RingQt applications. Instead of using global variables for windows objects and connecting events to objects using the object name, the Objects Library will manage the GUI objects and will provide a more natural API to quickly create one or many windows from the same class and the library provide a way to quickly set methods to be executed when an event is fired. Also the library provide a natural interface to quickly use the parent or the caller windows from the child or sub windows. The Objects Library is designed to be used with the MVC Design Pattern. The Objects Library is merged in RingQt so you can use it directly when you use RingQt 54.1 Library Usage • Use the Open_Window(cWindowControllerClassName) function to open new Windows • Create at least Two Classes for each window, The Controller Class and the View Class • Create each controller class from the WindowsControllerParent Class • Create each view class from the WindowsViewParent Class • Use the Last_Window() function to get the object of the last window created (The Controller object). • When you call a sub window, use the SetParentObject() method and pass the self object. • In the View Class, To determine the event method use the Method(cMethodName) function. • The Method(cMethodName) function determine the method in the controller class that will be executed. • Each controller class contains by default the CloseAction() method that you can call to close the window. • You don’t need to call the Show() Method for each window, When you use Open_Window() It will be called. • In the view class, Define the GUI window object as an attribute called win. • You can use Open_WindowNoShow() to avoid displaying the window. • You can use Open_WindowAndLink() to quickly get methods to access the windows. 54.2 Example In the next example we will create two types of windows. • Main Window contains a button. When the user click on the button a sub window will be opened. 533
- 557. Ring Documentation, Release1.4.1 • The User Can click on the button many times to open many sub windows. • Each Sub Window contains Two buttons. • The first button in the sub window change the Main and the Sub Windows Titles. • The second button in the sub window close the Sub Window. load "guilib.ring" new qApp { open_window( :MainWindowController ) exec() } class MainWindowController from WindowsControllerParent oView = new MainWindowView func SubWindowAction Open_window( :SubWindowController ) Last_Window().SetParentObject(self) class MainWindowView from WindowsViewParent win = new qWidget() { SetWindowTitle("Main Window") btnSub = new qPushButton(win) { setText("Sub Window") setClickEvent( Method( :SubWindowAction ) ) } resize(400,400) } class SubWindowController from WindowsControllerParent oView = new SubWindowView func SetMainWindowTitleAction Parent().oView.win.SetWindowTitle("Message from the Sub Window") oView.win.SetWindowTitle("Click Event Done!") class SubWindowView from WindowsViewParent win = new qWidget() { SetWindowTitle("Sub Window") btnMsg = new qPushButton(win) { setText("Set Main Window Title") setClickEvent( Method( :SetMainWindowTitleAction ) ) } btnClose = new qPushButton(win) { Move(200,0) setText("Close") setClickEvent( Method( :CloseAction ) ) } resize(400,400) } The next screen shot after creating three sub windows. 54.2. Example 534
- 558. Ring Documentation, Release1.4.1 The next screen shot after clicking on the button in each sub window. 54.2. Example 535
- 559. Ring Documentation, Release1.4.1 54.3 Open_WindowAndLink() Function We can use the Open_WindowAndLink() function to connect between the application windows, pass messages (call methods) between the objects. This function uses Meta-programming to define dynamic methods in the Caller Class to use the dynamic objects of other windows that we create. Example : (Uses the Form Designer) First Window 1. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/twowindowspart5/firstwindowView.ring 2. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/twowindowspart5/firstwindowController.ring Second Window 1. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/twowindowspart5/secondwindowView.ring 2. https://github.com/ring-lang/ring/blob/master/applications/formdesigner/tests/twowindowspart5/secondwindowController.ring 54.3. Open_WindowAndLink() Function 536
- 560. Ring Documentation, Release1.4.1 In the next code for example (from FirstWindowController.ring) The Open_WindowAndLink() will create an object from the SecondWindowController Class Then will add the Method : SecondWindow(), IsSecondWindow() Methods to the FirstWindowController Class Also will add the Method : FirstWindow(), IsFirstWindow() Methods to the SecondWindowController Class So the SendMessage() method in FirstWindowController class can use the SecondWindow() method to access the object. This is more simple than using Last_Window(), Parent() and SetParentObject() methods. class firstwindowController from windowsControllerParent oView = new firstwindowView func OpenSecondWindow Open_WindowAndLink(:SecondWindowController,self) func SendMessage if IsSecondWindow() SecondWindow().setMessage("Message from the first window") ok func setMessage cMessage oView.Label1.setText(cMessage) 54.4 Objects Library Source Code The library source code is very simple, You can check the source code files • https://github.com/ring-lang/ring/blob/master/extensions/ringqt/objectslib/objects.ring • https://github.com/ring-lang/ring/blob/master/extensions/ringqt/objectslib/subwindows.ring 54.4. Objects Library Source Code 537
- 561. CHAPTER FIFTYFIVE USING THE FORMDESIGNER In this chapter we will learn about using the Form Designer. We can run the From Designer from Ring Notepad From the Menubar in Ring Notepad - View Menu - We can Show/Hide the Form Designer window. Also we can run the Form Designer in another window. From the Ring Notepad - Tools Menu - Select the Form Designer. 538
- 562. Ring Documentation, Release1.4.1 55.1 The Designer Windows • Toolbox : To select controls to be added to the window. • Properties : To set the properties of the active window or controls. • Design Region : To select, move and resize the window and the controls. 55.2 The Toolbox We have many buttons. • Lock : We can use it to draw many controls of the same type quickly. • Select : We can use it to select a control in the Design Region • Controls Buttons : Select a control to be added to the window. 55.3 The Properties • When we select the window or one control, We will have the selected object properties. • Also In the properties window we have a combobox to select the active control. • Some properties provide a button next to the property value. We can click on the button to get more options. • When we select more than one control, We will have options for multi-selection 55.1. The Designer Windows 539
- 563. Ring Documentation, Release1.4.1 55.4 Running Forms When we save the form file (*.rform), The Form Designer will create two Ring files • The Controller Class • The View Class For example, if the form file is helloworld.rform The form designer will generate two files • helloworldcontroller.ring • helloworldview.ring To run the program, Open the controller class file then click the Run button (CTRL+F5) Tip: When you open a form using Ring Notepad, the controller class will be opened automatically, So we can press (CTRL+F5) or click on the Run button while the form designer window is active. 55.5 Events Code 1. Just type the method name in the event property. 55.4. Running Forms 540
- 564. Ring Documentation, Release1.4.1 (2) Then write the method code in the controller class. 55.5. Events Code 541
- 565. Ring Documentation, Release1.4.1 In this example we write func CloseWindow oView.win.close() Where inside the controller class, We uses the oView object to access the form. Another Example : 55.5. Events Code 542
- 566. Ring Documentation, Release1.4.1 The Event Code func SayHello oView { LineEdit2.setText("Hello "+ LineEdit1.text() ) } 55.6 Keyboard Shortcuts After selecting one or group of controls • Use the Arrows (Up, Down, Left and Right) to move them around. • Shift + the Arrows (Up, Down, Left and Right) to Resize the controls. • Del button to delete the controls. • CTRL+SHIFT+V to Duplicate the controls. 55.7 Menubar Designer From the Window properties we can open the Menubar Designer 55.6. Keyboard Shortcuts 543
- 567. Ring Documentation, Release1.4.1 55.8 Window Flags From the Window properties we can open the Window Flags window. 55.8. Window Flags 544
- 568. Ring Documentation, Release1.4.1 55.9 Entering Items For some controls like the List Widget we can enter items separated by comma ‘,’ 55.10 Using Layouts 1. To use layouts, At first add the layout control to the window. 2. Use the window “Set Layout” property to determine the main layout. 3. From the layout properties determine the controls and the layout type. 55.11 More Samples and Tests Check the folder : ring/applications/formdesigner/tests Online : https://github.com/ring-lang/ring/tree/master/applications/formdesigner/tests 55.9. Entering Items 545
- 569. CHAPTER FIFTYSIX SCOPE RULES FORVARIABLES AND ATTRIBUTES In this chapter we will learn about scope rules and how Ring find variables. Also we will learn about conflicts and how to solve/avoid them. The next information are important once you start developing large applications using Ring These application may uses • Global variables (Try to avoid them) • Classes (Object-Oriented) • braces { } to access objects • Declarative Programming • Natural Programming 56.1 Three Scopes In Ring we have three scopes :- 1. Public/Global Scope - Each variable you define in the statements part (before functions and classes) 2. Object Scope - When you are inside an object (Inside class method or using { } to access the object ) 3. Local Scope - Related to functions and methods 56.2 Defining Variables and Variables Access 1. Ring uses lexical scoping, i.e. the scope of the variable is based on where we defined the variable. 2. Inside braces { } when you access an object, You will change the current active object scope to this object scope but you still can access the global scope and the local scope. 3. After the ‘Class’ keyword and the class name, when you write variable names to be defined as attributes, You still can access the global scope. In this region (class region - after the class name and before methods) we have • Global Scope —-> The Global Scope • Object Scope —-> The Object Scope • Local Scope —-> The Object Scope 546
- 570. Ring Documentation, Release1.4.1 Note: Since the local scope in the class region point also to the object scope in this region, we can use nested braces and still have access to the object scope of the class through the local scope. Tip: You can create windows and controls as attibutes by defining them in this region. Tip: In the class region if you created objects and used braces {} to access them then using self.attribute inside braces will use the class (not the object that you access) because you have access to the class through the local scope. 4. Function Parameters are automatically defined in the local scope. 56.3 How Ring find the variable? 1 - Search First in the Local Scope if not found ! 2 - Search in the Object Scope if not found ! 3 - Search in the public scope if not found —-> Runtime Error if found —-> Check if we can do optimization to avoid searching next time (Cache / Pointers for performance). 56.4 Using Object.Attribute When we use object.attribute the search will be in the object attributes only. I.e. no search will be done in the local scope or in the global scope for the object attribute. Note: Using self.attribute will search for the first self before searching for attributes. 56.5 The Self Object The self object is a reference to the current object that we can use from the class methods. When we are inside class method and use Self we mean the object that will be created from this class. Inside the class methods if we used Braces { } this will change the current object scope and self will be changed also inside braces to reference the object that we access using Braces. Inside the Class Region (after the class name and before any method) we have access to the object through the object scope and the local scope also. In this region using Self will always be a reference to the class object. if we used Braces to change the object scope then used Self inside Braces, Also self will be a reference to the class object (not the object that we already access using braces) because in the class region we have :- • Global Scope —> Global Scope • Object Scope —> Object Scope 56.3. How Ring find the variable? 547
- 571. Ring Documentation, Release1.4.1 • Local Scope —> Object Scope And using Braces changes the object scope only (not the local scope) and when Ring search for variables it will search in the Local Scope first so it will find self in the class that we are inside. 56.6 How Ring Define Variables and Attributes Ring will use the variable name in the Assignment operation 1 - Search using the variable name 2 - If not found —> Avoid the runtime error and define the variable in the current scope 3 - If found —> Use the variable and don’t define anything in the current scope • In the global region (before any function or class) the current scope is the global scope. • In the class region (after the class name and before any method) the current scope is the object attributes. • In Functions and methods the current scope is the local scope. 56.7 Conflict between Global Variables and Class Attributes Look at this example: name = "test" o1 = new person see o1 class person name address phone In the previous example we have a global variable called ‘name’ inside the class person. when we use the variable ‘name’, Ring will start the search operation and will try to find it. if found —> Use it if not found —> Define new attribute But the variable name is a global variable, so it will be found and used! We will not have the attribute name! added to the object. Solution (1) - Use the Main Function func main name = "test" o1 = new person see o1 class person name address phone Solution (2) - Use special mark for global variable names like $ 56.6. How Ring Define Variables and Attributes 548
- 572. Ring Documentation, Release1.4.1 $name = "test" o1 = new person see o1 class person name address phone Solution (3) - Use the AddAttribute() Method name = "test" o1 = new person see o1 class person AddAttribute(self,"name") address phone Solution (4) - Use self before the attribute name name = "test" o1 = new person see o1 class person self.name address phone So what is the best solution to this conflict? 1 - Use the $ Mark for global variables 2 - Optional : Try to avoid global variables and use the Main function In practice i do both of them. The other solution • Use self before the attribute name or use AddAttribute() 56.8 Conflict between Class Attributes and Local Variables This conflict may happen when we access the object using braces Example: func main name = "nice" o1 = new person {name="mahmoud" address="Egypt" phone = 000 } see o1 class person name address phone 56.8. Conflict between Class Attributes and Local Variables 549
- 573. Ring Documentation, Release1.4.1 In the previous example we have the local variable name. The value of this variable will be set to “mahmoud” instead of the object attribute. Solution (1) : Just use Self func main name = "nice" o1 = new person {self.name="mahmoud" address="Egypt" phone = 000 } see o1 class person name address phone Solution (2) : Change the Local variable name func main cName = "nice" o1 = new person {name="mahmoud" address="Egypt" phone = 000 } see o1 class person name address phone Solution (3) : Change Braces and use the Dot operator func main name = "nice" o1 = new person o1.name ="mahmoud" o1.address ="Egypt" o1.phone = 000 see o1 class person name address phone 56.9 Using Braces to access objects inside Class Methods Remember that we have Three scopes (Local Scope, Object Scope and Global Scope) and when we are inside a class method, we expect that we have access to the object attributes and methods and this is true until we use braces to access another object attributes and methods because in this case our object scope will be switched to another object. new point { test() } class point x=10 y=20 func test see x + nl + y + nl # works fine myobj = new otherclass { see name + nl see x + nl + y + nl # error ! 56.9. Using Braces to access objects inside Class Methods 550
- 574. Ring Documentation, Release1.4.1 } class otherclass name = "test" Output: 10 20 test Line 8 Error (R24) : Using uninitialized variable : x In method test() in file methodbraceerror.ring called from line 5 in file methodbraceerror.ring Now what we will do to solve the previous problem? Solution (1) : Write the code that access the class attributes outside braces. new point { test() } class point x=10 y=20 func test see x + nl + y + nl # works fine myobj = new otherclass { see name + nl } see x + nl + y + nl # Outside braces - works fine class otherclass name = "test" Output: 10 20 test 10 20 Solution (2) : Don’t Use Braces new point { test() } class point x=10 y=20 func test see x + nl + y + nl myobj = new otherclass see myobj.name see x + nl + y + nl class otherclass name = "test" Solution (3) : Copy the self object We may use this solution if we want to use braces and get access to the class attributes (Just Reading). 56.9. Using Braces to access objects inside Class Methods 551
- 575. Ring Documentation, Release1.4.1 new point { test() } class point x=10 y=20 func test oSelf = self see x + nl + y + nl myobj = new otherclass { see name + nl see oself.x + nl + oself.y + nl } class otherclass name = "test" Output: 10 20 test 10 20 Now look at this line oself = self The problem with the previous line is that we will have a new copy from the object Because in Ring the assignment operator copy lists and objects by value (not by reference). When we access the new object attributes (reading) we don’t have problems But if we modified the object attributes (Then we will modify the copy!). Note: We can use braces again with the copy new point { test() } class point x=10 y=20 func test oSelf = self see x + nl + y + nl myobj = new otherclass { see name + nl oSelf { see x + nl + y + nl } } class otherclass name = "test" In a GUI application, we may create a class contains the window objects as attributes to be able to access the controls from different methods. Remember the previous information when you try to access objects using braces inside methods because in this case you can’t access the object attributes directly and if you copied the self object you will work on a copy and the new controls that you create will be related to the copy and you can’t access them. 56.9. Using Braces to access objects inside Class Methods 552
- 576. Ring Documentation, Release1.4.1 56.10 Accessing the class attributes from braces inside class meth- ods We access the class attributes directly from the class methods, also we have the choice to use the Self reference before the attribute/method name. Using Braces {} inside class method change the active object scope and prevent us from getting direct access to the class attributes. Also using Self will not help because the Self reference will be changed to the object that we access using Braces. In this case if you want to read an attribute you have to copy the Self object before using Braces and if you want to modify an attribute you have to the copy from local variable to the object attribute after using Braces. This case happens when you want to read/modify attribute insead braces. Class MyApp oCon # Attribute # some code here Func OpenDatabase # some code here new QSqlDatabase() { oCon = addDatabase("QSQLITE") { setDatabaseName("weighthistory.db") open() } } self.oCon = oCon # some code here In the previous example we want to create the connection object and save it inside the oCon attribute. The object is an output from the addDatabase() method that we use after accessing the QSQLDatabase() object. Inside braces we can’t use the Self reference to use the object created from the MyApp class, Because the Self reference here will be to the object that we access using Braces. We solved the problem in the previous example by creating a local variable called oCon then after Braces we copied that variable to the oCon attribute. The next code is another solution. Class MyApp oCon # Attribute # some code here Func OpenDatabase # some code here oCon = new QSqlDatabase() oCon = oCon.addDatabase("QSQLITE") { setDatabaseName("weighthistory.db") Open() } # some code here The next code is a better solution. 56.10. Accessing the class attributes from braces inside class methods 553
- 577. Ring Documentation, Release1.4.1 Class MyApp oCon # Attribute # some code here Func OpenDatabase # some code here new QSqlDatabase() { this.oCon = addDatabase("QSQLITE") { setDatabaseName("weighthistory.db") Open() } } # some code here Note: We used this.attribute to access the class attribute (oCon) while we are inside Braces. 56.11 Creating a Class for each Window in GUI applications A good way for creating classes for windows is to define the window directly after the class name In this area you can use nested braces without problems to define the window and the controls, and they will be attributes that you can access from methods. Example: Load "guilib.ring" new qApp { $ObjectName = "oFirstWindow" oFirstWindow = new FirstWindow $ObjectName = "oSecondWindow" oSecondWindow = new SecondWindow exec() } Class FirstWindow win = new qWidget() { setgeometry(0,50,300,200) setWindowTitle("First Window") label1 = new qLabel(win) { setgeometry(10,10,300,30) setText("0") } btn1 = new qPushButton(win) { move(100,100) setText("Increment") setClickEvent($ObjectName+".increment()") } 56.11. Creating a Class for each Window in GUI applications 554
- 578. Ring Documentation, Release1.4.1 show() } Func Increment label1 { setText( "" + ( 0 + text() + 1 ) ) } Class SecondWindow win = new qWidget() { setgeometry(400,50,300,200) setWindowTitle("Second Window") label1 = new qLabel(win) { setgeometry(10,10,300,30) setText("0") } btn1 = new qPushButton(win) { move(100,100) setText("Decrement") setClickEvent($ObjectName+".decrement()") } show() } Func Decrement label1 { setText( "" + ( 0 + text() - 1 ) ) } 56.12 Conflict between self inside braces and self in the class region In the class region (after the class name and before any methods) we define the attributes. In this region we have access to the global scope and the local scope will point to the object scope. Three Scopes • Global Scope —> Gloabl Scope • Object Scope —> Object Scope • Local Scope —> Object Scope Look at this example New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] aFriends + new Friend { name = "Gal" 56.12. Conflict between self inside braces and self in the class region 555
- 579. Ring Documentation, Release1.4.1 } aFriends + new Friend { name = "Bert" } Class Friend name Output: name: NULL name: NULL The problem in the previous example is that the Class account contains an attribute called “name” and the Friend class contains an attribue called “name” also. If you tried using self.name inside braces you will get the same result! New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] aFriends + new Friend { self.name = "Gal" } aFriends + new Friend { self.name = "Bert" } Class Friend name So why using self.name inside braces doesn’t solve this conflict? Because after the class region we have • global scope —> global scope • object scope —> object scope (Account Class) • local scope —> local scope (Account Class) When we use braces we change the object scope, so we have • global scope —> global scope • object scope —> object scope (Friend Class) • local scope —> local scope (Account Class) Ring search in the local scope first, so using self.name will use the Account class. There are many solution Solution (1) : Access the object through the list New Account { see aFriends } Class Account 56.12. Conflict between self inside braces and self in the class region 556
- 580. Ring Documentation, Release1.4.1 name = "Mahmoud" aFriends = [] aFriends + new Friend aFriends[len(aFriends)] { aFriends[len(aFriends)].name = "Gal" } aFriends + new Friend aFriends[len(aFriends)] { aFriends[len(aFriends)].name = "Bert" } Class Friend name Solution (2) : Create Method in the friend class to set the name attribute. New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] aFriends + new Friend { setname("Gal") } aFriends + new Friend { setname("Bert") } Class Friend name func setname cName name = cName Solution (3) : Create a method in the account class to set the attribute New Account { see aFriends } Class Account name = "Mahmoud" aFriends = [] friend("Gal") friend("Bert") func friend cName aFriends + new Friend { name = cName } Class Friend name Solution (4) : Declarative Programming New Account { name = "mahmoud" friend { 56.12. Conflict between self inside braces and self in the class region 557
- 581. Ring Documentation, Release1.4.1 name = "Gal" } friend { name = "Bert" } see aFriends } Class Account name aFriends = [] friend func getfriend aFriends + new Friend return aFriends[len(aFriends)] Class Friend name Output: name: Gal name: Bert 56.13 Using braces to escape from the current object scope Since braces change the current object scope to another object. we can use it to do some work without modifying the class attributes and using the same variable names. new point {x=10 y=20 z=30 start() } class point x y z func start see self # print the x y z values (10,20,30) new Local { x = 100 y = 200 z = 300 } see self # print the x y z values (10,20,30) see x + nl # will print 100 see y + nl # will print 200 see z + nl # will print 300 Self { # NO Advantage - Search is done in local scope first see x + nl # will print 100 see y + nl # will print 200 see z + nl # will print 300 } see self.x + nl # will print 10 see self.y + nl # will print 20 see self.z + nl # will print 30 class Local Output: x: 10.000000 y: 20.000000 56.13. Using braces to escape from the current object scope 558
- 582. Ring Documentation, Release1.4.1 z: 30.000000 x: 10.000000 y: 20.000000 z: 30.000000 100 200 300 100 200 300 10 20 30 56.14 Summary of Scope Rules At first remember that 1 - Each programming language comes with it’s scope rules based on the language goals 2 - Programming in the small is different than Programming in the Large 3 - Some programming language are designed for developing small programs while others are designed for large programs 4 - In programming, If we have access to more than one scope - Then problems may come if we don’t manage things correctly 5 - It’s always more secure to reduce the number of visible scopes 6 - Some programming languages force you to manage the scope in some way, while others not! In Ring 1 - Special and very simple scope rules that are designed for Flexibility first then Security 2 - Ring is designed to support programming in the small and programming in the large. 3 - The language provide the different programming paradigms that you may select from based on the project size. Errors comes only if you selected a bad paradigm for the target project or you are using the paradigm in a way that is not correct or at least not common. 4 - In Ring you have the choice, you can use global variables or avoid them. you can give them a special $ mark or leave them. you can use object-oriented or stay with procedures. you can use the class region (after the class name and before any method) just for attributes or use it for code too. 5 - Just read the next scope rules and think about them then use them in your favorite way. Scope Rules: 1 - At any place in our program code we have only at maximum Three Scopes (Local Scope, Object Scope and Global Scope). 2 - When Ring find a variable it will search in the local scope first then in the object scope then in the global scope. 3 - At any time inside procedures or methods you can use braces { } to access an object and change the current object scope. 4 - In the class region (After the class name and before any method) this is a special region where both of the object scope and the local scope point to the object scope. I.e. No local variables where each variable you define in this region will become an attribute. 56.14. Summary of Scope Rules 559
- 583. Ring Documentation, Release1.4.1 5 - Before defining any variable (in any scope and in the class region too) a search process will be done to use the variable if it’s found. 6 - Functions and Methods parameters are defined automatically as local variables to these functions or methods. 7 - Using Object.Attribute will search in the object attributes only. 8 - Using Self.Attribute will lead to a search for Self first then search in Self Attributes. 9 - The Self reference inside class region (after the class name and before any method) always point to the object scope created from the class. 10- The Self reference inside methods will be changed when we uses Braces to be a reference to the object that we access. 11- Writing variable names directly in the class region (after the class name and before any method) means using them or define then (in order). 12- Using self.attribute in the class region reduce search to the object scope (avoid conflict with global scope). From these rules you can understand all types of conflicts and why you may have them and how to avoid them Simple advices to avoid any conflict and use the scope rules in a better way 1 - Try to avoid global variables 2 - Use the Main Function - This will help you to avoid global variables 3 - If you are going to use many global variables use the $ mark before the variable name 4 - In the class region if you don’t respect the advice number three ($) then use self.attribute when you define your attributes 5 - You can use object.attribute and object.method() instead of object { attribute } and object { method() } if you don’t like changing the object scope. 6 - If you will use nested braces in a class - think about using the class region if possible because in this region you will have access to the object that you access using { } + access to the class attributes 7 - If you are inside a class method and used nested braces you will change the object scope with each brace and you will loss the access to the class attributes directly but you have access to the local scope before and after using brace { } , if you will read/modify the class attribute from braces then use This.Attribute because using ‘This’ means (The object created from this class) while using ‘Self’ means (The object in the current object scope). After understanding all of the previous points, You will master this topic. 56.14. Summary of Scope Rules 560
- 584. CHAPTER FIFTYSEVEN SCOPE RULES FORFUNCTIONS AND METHODS In this chapter we will learn about the scope rules for functions and methods. You need to know the next information once you started using Ring for large applications. These applications may contains and use • Many Packages and Classes written in Ring • Many Functions written in Ring • Standard Ring Functions (Written in C language) • Functions and Classes written in C/C++ languages 57.1 How Ring find the Functions and Methods? When you call a method or function, Ring will start a search process to find this function If found –> Call the function and store the function pointer in the cache so Ring can use it again with doing another search. If not found —> Runtime error message (That you can avoid using Try/Catch) How the search process is done? Search for functions/methods follow the next order 1 - Search in methods (if we are inside class method or object using braces {}) 2 - Search in functions written by the programmer using Ring Code 3 - Search in functions written in C/C++ like standard Ring functions This enable us to write clean code inside classes methods and avoid any conflict with functions. If we want to call a function with the same name as a method in the class we will need a wrapper function or we will access a temp. object using { } then call that function there. We can replace C/C++ Functions with Ring Functions. We can replace Ring Functions with Ring Methods. Note: Using self.method() is not necessary in any use case. Tip: We can use this.method() to escape from the current active scope that we access using braces {} and call a method in the class that we are inside. 561
- 585. Ring Documentation, Release1.4.1 57.2 Example about Sharing Names between Functions and Methods Look at the next example func main o1 = new myclass { test() test2() } test2() func f1 see "f1 function" + nl func f2 see "f2 function" + nl func f3 see "f3 function" + nl func test2 myline() see "test2 function" + nl new myclass { f1() f2() f3() self.f3() } myobj = new myclass myobj.f3() myline() func myline see copy("=",40) + nl Class myclass func test myline() see "test method" + nl f1() f2() f3() myline() func f3 see "f3 method" + nl func test2 myline() see "test2 method" + nl self { f1() f2() f3() } myline() Output: 57.2. Example about Sharing Names between Functions and Methods 562
- 586. Ring Documentation, Release1.4.1 ======================================== test method f1 function f2 function f3 method ======================================== ======================================== test2 method f1 function f2 function f3 method ======================================== ======================================== test2 function f1 function f2 function f3 method f3 method f3 method ======================================== 57.3 Calling a function sharing the name with a method in the current class In the previous example we have a function called f3() and we have a method called f3() How we can call the f3() function from the test() method ? Solution (1) : Change the current object scope to another object scope In this solution we will have an empty class called local that we will use to change the current object scope. func main o1 = new myclass { test()} func f1 see "f1 function" + nl func f2 see "f2 function" + nl func f3 see "f3 function" + nl func myline see copy("=",40) + nl Class myclass func test myline() see "test method" + nl f1() f2() f3() # call f3() method new local { f3() } # call f3() function myline() 57.3. Calling a function sharing the name with a method in the current class 563
- 587. Ring Documentation, Release1.4.1 func f3 see "f3 method" + nl class local Output: ======================================== test method f1 function f2 function f3 method f3 function ======================================== 57.3. Calling a function sharing the name with a method in the current class 564
- 588. CHAPTER FIFTYEIGHT SYNTAX FLEXIBILITY In thischapter we will learn about some options that are provided automatically by the Ring compiler for syntax flexibility. 58.1 Change Language Keywords We can change any keyword using the ChangeRingKeyword command. Note: Remember to restore the keyword again if the team will mix between styles in the same project. Tip: The ChangeRingKeyword command is executed in the scanner stage by the compiler (before parsing). Syntax: ChangeRingKeyword <oldkeyword> <newkeyword> Example: ChangeRingKeyword see print print "welcome" + nl ChangeRingKeyword print see see "Welcome" + nl Example: ChangeRingKeyword func function ChangeRingKeyword see print ChangeRingKeyword ok endif ChangeRingKeyword next endfor ChangeRingKeyword end endwhile x = 10 while x > 0 print "x = " + x + nl for t = 1 to 10 if t = 3 print "number three" + nl endif endfor 565
- 589. Ring Documentation, Release1.4.1 x-- endwhile test() function test print "message from test" + nl ChangeRingKeyword function func ChangeRingKeyword print see ChangeRingKeyword endif ok ChangeRingKeyword endfor next ChangeRingKeyword endwhile end 58.2 Change Language Operators We can change any operator using the ChangeRingOperator command. Note: Remember to restore the operator again if the team will mix between styles in the same project. Tip: The ChangeRingOperartor command is executed in the scanner stage by the compiler (before parsing). Syntax: ChangeRingOperator <oldkeyword> <newkeyword> Example: The next program hide the + operator by changing it to _+ changeringoperator + _+ changeringkeyword SEE PRINT try print 5 + 10 catch print nl print "error" print nl done changeringoperator _+ + The next program change the + operator to “plus”. changeringoperator + plus changeringkeyword SEE PRINT Print 5 plus 5 changeringoperator plus + changeringkeyword PRINT SEE 58.2. Change Language Operators 566
- 590. Ring Documentation, Release1.4.1 58.3 Load Syntax Files You may store a group of ChangeRingKeyword and ChangeRingOperator commands in a file to use later in many source files. You can’t use the Load command to call these files because • ChangeRingKeyword and ChangeRingOperator commands are executed in the scanner phase by the compiler (before parsing). • The load command is executed in the parsing phase (after the scanner phase). Solution: Use the LoadSyntax Command which is executed in the scanner phase. Syntax: LoadSyntax "syntaxfile.ring" Example: File : StyleBasicOn.ring ChangeRingKeyword see print ChangeRingKeyword ok endif ChangeRingKeyword next endfor ChangeRingKeyword end endwhile File : StyleBasicOff.ring ChangeRingKeyword print see ChangeRingKeyword endif ok ChangeRingKeyword endfor next ChangeRingKeyword endwhile end File : UseStyleBasic.ring LoadSyntax "stylebasicon.ring" x = 10 while x > 0 print "x = " + x + nl for t = 1 to 10 if t = 3 print "number three" + nl endif endfor x-- endwhile LoadSyntax "stylebasicoff.ring" see "done" + nl Note: files called by the LoadSyntax command must contains ChangeRingKeyword and ChangeRingOperator com- mands only. Tip: files called by the LoadSyntax command doesn’t support functions, packages and classes. just imperative commands only. Note: Using this feature you can create many styles that you can use in the same project and you can support Ring 58.3. Load Syntax Files 567
- 591. Ring Documentation, Release1.4.1 translation to other languages like Arabic, French and so on. 58.4 Using “()” around the function parameters We can use () around the function parameters (optional). Example: hello() sum(3,4) func hello() see "Hello" + nl func sum(x,y) see x+y+nl Output: Hello 7 Example: myfunc = func x,y { see x + y + nl } call myfunc (3,4) myfunc2 = func (x,y) { see x+y+nl } call myfunc(3,4) Output: 7 7 58.5 Using Semi-colon after and between statements In Ring we can use semi-colon after and between statements (optional). Example: # Using semi-colon is optional see "Hello" + nl ; see "How are you?" + nl ; see "Welcome to Ring" + nl ; one() ; two() ; three() ; func one ; see "one" + nl ; func two ; see "two" + nl ; func three ; see "three" + nl ; Output: Hello How are you? Welcome to Ring 58.4. Using “()” around the function parameters 568
- 592. Ring Documentation, Release1.4.1 one two three 58.6 Using $ and @ in the start of the variable name You can use any unicode character in the variable name also we can use $ and @ in the name. This feature may help, for example we can start global variables with $ and the object attributes with @. In other languages like Ruby this is the rule, In the Ring language this is just an option without any force from the Compiler. example: $global_variable = 5 new test { hello() } class test @instance_variable = 10 func hello local_variable = 15 see "Global : " + $global_variable + nl + "Instance : " + @instance_variable + nl + "Local : " + local_variable + nl Output: Global : 5 Instance : 10 Local : 15 58.7 Using the ‘elseif’ keyword as ‘but’ in if statement if you don’t like the ‘but’ keyword in if statement Then you can use the ‘elseif’ keyword. Example: give x if x = 1 see "one" elseif x=2 see "two" elseif x=3 see "three" elseif x=4 see "four" else see "other" ok see nl 58.6. Using $ and @ in the start of the variable name 569
- 593. Ring Documentation, Release1.4.1 58.8 Using the ‘else’ keyword as ‘other’ in switch statement if you don’t like the ‘other’ keyword in switch statement Then you can use the ‘else’ keyword. Also you can replace ‘else’ with ‘other’ in if statement. i.e. ‘other’ keyword is the same as ‘else’ keyword. Example: x = 1 switch x on 10 see "10" + nl else see "not 10" + nl end Output: not 10 58.9 Using the ‘end’ keyword in different control structures We can use the ‘end’ keyword to close different control structures • If statement • For loop • Switch • While • Try-Catch Example: see "if statement.." + nl x = 1 if x = 1 see "one" + nl elseif x=2 see "two" + nl elseif x=3 see "three" + nl end see "for loop.." + nl for t = 1 to 10 see t end see nl see "switch..." + nl x = 1 switch x on 1 see "one" + nl on 2 see "two" + nl end 58.8. Using the ‘else’ keyword as ‘other’ in switch statement 570
- 594. Ring Documentation, Release1.4.1 see "try catch..." + nl try x = 1 / 0 catch see "catching error" + nl end Output: if statement.. one for loop.. 12345678910 switch... one try catch... catching error 58.10 Using braces to start and end different control structures We can use braces { } to start and end different control structures • If statement • For loop • Switch • While • Try-Catch Example: see "if statement.." + nl x = 1 if x = 1 { see "one" + nl elseif x=2 see "two" + nl elseif x=3 see "three" + nl } see "for loop.." + nl for t = 1 to 10 { see t } see nl see "switch..." + nl x = 1 switch x { on 1 see "one" + nl on 2 see "two" + nl } see "try catch..." + nl try { 58.10. Using braces to start and end different control structures 571
- 595. Ring Documentation, Release1.4.1 x = 1 / 0 catch see "catching error" + nl } Output: if statement.. one for loop.. 12345678910 switch... one try catch... catching error 58.11 Using ‘put’ and ‘get’ as ‘see’ and ‘give’ We can replace the ‘see’ keyword with the ‘put’ keyword. Also we can replacew the ‘give’ keyword with the ‘get’ keyword. Example: put "Hello World" + nl put "Enter Your Name ? " Get Name Put "Hello " + Name 58.12 Using ‘case’ as ‘on’ in switch statements We can replace the ‘on’ keyword with ‘case’ keyword in the switch statement. Example (1) : for x=1 to 10 switch x case 1 put "one" + nl case 2 put "two" + nl case 3 put "thre" + nl else put "else" + nl end end Example (2) : for x=1 to 10 { switch x { case 1 put "one" + nl case 2 put "two" + nl case 3 put "thre" + nl else put "else" + nl } } 58.11. Using ‘put’ and ‘get’ as ‘see’ and ‘give’ 572
- 596. Ring Documentation, Release1.4.1 58.13 Using ‘def’ as ‘func’ in functions/methods definition We can use the ‘def’ keyword as the ‘func’ keyword to define functions and methods. Example: one() two() def one put "one" + nl def two put "two" + nl 58.13. Using ‘def’ as ‘func’ in functions/methods definition 573
- 597. CHAPTER FIFTYNINE DISTRIBUTING RING APPLICATIONS Inthis chapter we will learn about distributing Ring applications. 59.1 Distributing Applications for Microsoft Windows Step 1: Copy c:ringbin folder to be for example c:myapp Step 2: Rename c:myappring.exe to c:myappmyapp.exe Step 3: Create a file c:myappring.ring And write Load "myapp.ring" When you run myapp.exe the file ring.ring will be executed automatically So your file myapp.ring will be called and executed Or just rename myapp.ring to ring.ring It’s a fast way to distribute applications. 59.2 Protecting the Source Code Step 1: Execute the next command ring myapp.ring -go This will generate one object file (myapp.ringo) from the project files (*.ring) Step 2: Rename myapp.ringo to ring.ringo When you run the executable file (ring.exe) or (myapp.exe) the file ring.ringo will be executed. 574
- 598. Ring Documentation, Release1.4.1 59.3 Creating Windows Installer There are many tools that you can use to distribute your application. Check : nullsoft scriptable install system URL : http://nsis.sourceforge.net/Main_Page 59.4 Using C/C++ Compiler and Linker Another method to distribute applications is to use a C/C++ compiler. Ring can be embedded in C/C++ projects, We can create executable files using a C/C++ compiler by embedding the Ring language in our project. Check the “Embedding Ring Language in C/C++ Programs” chapter. Using this way we will avoid using ring.ring or ring.ringo files. 59.5 Distributing Applications and Games for Mobile Ring can be embedded in a Qt projects or LibSDL projects to build Mobile applications and Games. You can build the Qt project or the LibSDL project and get the Android package directly (*.apk) Check Ring distributions for Mobile development using Qt or LibSDL. 59.3. Creating Windows Installer 575
- 599. CHAPTER SIXTY COMMAND LINE OPTIONS Thering language takes source code file (.ring) or the object file (.ringo) as input to execute, also the language provide other options like Option Description -tokens Print a list of tokens in the source code file -rules Print grammar rules applied on the tokens -ic Print the intermediate byte code (before execution) -icfinal Print the final byte code (after execution) -cgi Print http response header before error messages -norun Don’t run the program after compiling -ins Print instruction operation code before execution -performance Print clock before and after program execution -go Generate Object File -w Display Warnings 60.1 Printing Tokens Example: Func Main See "Hello World" + nl for x = 1 to 10 see x + nl next test() func test see "welcome" + nl o1 = new point { x=10 y=20 z=30 } see o1 class point x y z Command: ring test.ring -tokens -norun Output: =================================================== Tokens - Generated by the Scanner =================================================== 576
- 600. Ring Documentation, Release1.4.1 Keyword : FUNC Identifier : main EndLine Keyword : SEE Literal : Hello World Operator : + Identifier : nl EndLine Keyword : FOR Identifier : x Operator : = Number : 1 Keyword : TO Number : 10 EndLine Keyword : SEE Identifier : x Operator : + Identifier : nl EndLine Keyword : NEXT EndLine Identifier : test Operator : ( Operator : ) EndLine Keyword : FUNC Identifier : test EndLine Keyword : SEE Literal : welcome Operator : + Identifier : nl EndLine Identifier : o1 Operator : = Keyword : NEW Identifier : point Operator : { Identifier : x Operator : = Number : 10 Identifier : y Operator : = Number : 20 Identifier : z Operator : = Number : 30 Operator : } EndLine Keyword : SEE Identifier : o1 EndLine Keyword : CLASS Identifier : point Identifier : x Identifier : y Identifier : z 60.1. Printing Tokens 577
- 601. Ring Documentation, Release1.4.1 EndLine =================================================== 60.2 Printing Rules Command: ring test.ring -rules -norun Output: =================================================== Grammar Rules Used by The Parser =================================================== Rule : Program --> {Statement} Line 1 Rule : Statement --> 'Func' Identifier [ParaList] Line 2 Rule : Factor --> Literal Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Arithmetic --> Arithmetic + Arithmetic Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 3 Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic 60.2. Printing Rules 578
- 602. Ring Documentation, Release1.4.1 Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'For' Identifier '=' Expr to Expr ['step' Expr] Line 4 Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Arithmetic --> Arithmetic + Arithmetic Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 5 Rule : Next --> 'Next' Line 6 Rule : Mixer -> '(' [Expr { ',' Expr} ] ')' Line 8 Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Statement --> 'Func' Identifier [ParaList] Line 9 Rule : Factor --> Literal Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : Arithmetic --> Arithmetic + Arithmetic 60.2. Printing Rules 579
- 603. Ring Documentation, Release1.4.1 Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 10 Rule : Factor --> New Identifier {'.' Identifier } Rule : Mixer --> '{' {Statement} BraceEnd Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot 60.2. Printing Rules 580
- 604. Ring Documentation, Release1.4.1 Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Number Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : BraceEnd --> '}' Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Assignment -> '=' Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Line 11 Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift 60.2. Printing Rules 581
- 605. Ring Documentation, Release1.4.1 Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> 'See' Expr Line 13 Rule : Statement --> 'Class' Identifier Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr Rule : Factor --> Identifier [ {Mixer} | Assignment | PlusPlus | MinusMinus] Rule : Range --> Factor Rule : Term --> Range Rule : Arithmetic --> Term Rule : BitShift --> Arithmetic Rule : BitAnd --> BitShift Rule : BitOrXOR --> BitAnd Rule : Compare --> BitOrXOR Rule : EqualOrNot --> Compare Rule : LogicNot -> EqualOrNot Rule : Expr --> LogicNot Rule : Statement --> Expr =================================================== 60.3 Printing Intermediate Code Command: ring test.ring -ic -norun Output: 60.3. Printing Intermediate Code 582
- 606. Ring Documentation, Release1.4.1 =================================================== Byte Code - Before Execution by the VM =================================================== PC OPCode Data 1 ReturnNull 2 Func main 3 NewLine 2 4 FuncExE 5 PushC Hello World 6 LoadA nl 0 7 PushV 8 SUM 0 9 Print 10 NewLine 3 11 ExitMark 29 28 12 LoadAFirst x 13 PushN 1.000000 14 BeforeEqual 0 15 Assignment 16 PushN 1.000000 17 StepNumber 18 JumpVarLENum x 10.000000 29 19 NewLine 4 20 FuncExE 21 LoadA x 0 22 PushV 23 LoadA nl 0 24 PushV 25 SUM 0 26 Print 27 NewLine 5 28 IncJump x 18 29 POPExitMark 30 POPStep 31 NewLine 6 32 LoadFunc test 33 Call 0 34 NoOperation 35 NewLine 8 36 PushV 37 FreeStack 38 ReturnNull 39 Func test 40 NewLine 9 41 FuncExE 42 PushC welcome 43 LoadA nl 0 44 PushV 45 SUM 0 46 Print 47 NewLine 10 48 LoadA o1 0 49 AssignmentPointer 50 New point 51 SetScope 52 PushV 60.3. Printing Intermediate Code 583
- 607. Ring Documentation, Release1.4.1 53 BraceStart 54 LoadA x 0 58 55 AssignmentPointer 56 PushN 10.000000 57 BeforeEqual 0 58 Assignment 0 0 59 FreeStack 60 LoadA y 0 64 61 AssignmentPointer 62 PushN 20.000000 63 BeforeEqual 0 64 Assignment 0 0 65 FreeStack 66 LoadA z 0 70 67 AssignmentPointer 68 PushN 30.000000 69 BeforeEqual 0 70 Assignment 0 0 71 FreeStack 72 LoadFunc ismethod 73 LoadA self 0 74 PushV 75 PushC braceend 76 Call 77 NoOperation 78 PushV 79 JumpZ 85 80 LoadFunc braceend 81 Call 82 NoOperation 83 PushV 84 FreeStack 85 BraceEnd 86 FreeStack 87 NewLine 11 88 FuncExE 89 LoadA o1 0 90 PushV 91 Print 92 NewLine 13 93 ReturnNull 94 Class point 006E8BC0 95 NewLabel 96 LoadA x 0 97 PushV 98 FreeStack 99 LoadA y 0 100 PushV 101 FreeStack 102 LoadA z 0 103 PushV 104 FreeStack 105 ReturnNull =================================================== 60.3. Printing Intermediate Code 584
- 608. Ring Documentation, Release1.4.1 60.4 Printing Final Intermediate Code Command: ring test.ring -icfinal Output: Hello World 1 2 3 4 5 6 7 8 9 10 welcome x: 10.000000 y: 20.000000 z: 30.000000 =================================================== Byte Code - After Execution by the VM =================================================== PC OPCode Data 1 ReturnNull 2 Func main 3 NewLine 2 4 FuncExE 5 PushC Hello World 6 PushP 007D3670 0 7 PushV 8 SUM 0 9 Print 10 NewLine 3 11 ExitMark 29 28 12 LoadAFirst x 13 PushN 1.000000 14 BeforeEqual 0 15 Assignment 16 PushN 1.000000 17 StepNumber 18 JumpVarLPLENum x 10.000000 29 19 NewLine 4 20 FuncExE 21 PushPLocal x 0 22 PushV 23 PushP 007D3670 0 24 PushV 25 SUM 0 26 Print 27 NewLine 5 60.4. Printing Final Intermediate Code 585
- 609. Ring Documentation, Release1.4.1 28 IncLPJump x 18 29 POPExitMark 30 POPStep 31 NewLine 6 32 LoadFuncP test 33 Call 0 34 NoOperation 35 NewLine 8 36 PushV 37 FreeStack 38 ReturnNull 39 Func test 40 NewLine 9 41 FuncExE 42 PushC welcome 43 PushP 007D3670 0 44 PushV 45 SUM 0 46 Print 47 NewLine 10 48 PushPLocal o1 0 49 AssignmentPointer 50 New point 51 SetScope 52 PushV 53 BraceStart 54 LoadA x 0 58 55 AssignmentPointer 56 PushN 10.000000 57 BeforeEqual 0 58 SetProperty 0 106 59 FreeStack 60 LoadA y 0 64 61 AssignmentPointer 62 PushN 20.000000 63 BeforeEqual 0 64 SetProperty 0 141 65 FreeStack 66 LoadA z 0 70 67 AssignmentPointer 68 PushN 30.000000 69 BeforeEqual 0 70 SetProperty 0 176 71 FreeStack 72 LoadFunc ismethod 73 LoadA self 0 74 PushV 75 PushC braceend 76 Call 77 NoOperation 78 PushV 79 JumpZ 85 80 LoadFunc braceend 81 Call 82 NoOperation 83 PushV 84 FreeStack 85 BraceEnd 60.4. Printing Final Intermediate Code 586
- 610. Ring Documentation, Release1.4.1 86 FreeStack 87 NewLine 11 88 FuncExE 89 PushPLocal o1 0 90 PushV 91 Print 92 NewLine 13 93 ReturnNull 94 Class point 007D8470 95 NewLabel 96 LoadA x 0 97 PushV 98 FreeStack 99 LoadA y 0 100 PushV 101 FreeStack 102 LoadA z 0 103 PushV 104 FreeStack 105 ReturnNull 106 LoadFunc ismethod 107 LoadA ring_gettemp_var 0 108 PushV 109 PushC setx 110 Call 0 111 NoOperation 112 PushV 113 JumpZ 132 114 NewLine 2 115 LoadA ring_gettemp_var 0 116 LoadMethod setx 117 LoadA ring_settemp_var 0 118 PushV 119 Call 0 1 120 AfterCallMethod 121 PushV 122 FreeStack 123 NewLine 3 124 LoadA ring_tempflag_var 0 128 125 AssignmentPointer 126 PushN 0.000000 127 BeforeEqual 0 128 Assignment 0 0 129 FreeStack 130 NewLine 4 131 Jump 140 132 NewLine 5 133 PushP 007D37D8 0 137 134 AssignmentPointer 135 PushN 1.000000 136 BeforeEqual 0 137 Assignment 0 0 138 FreeStack 139 NewLine 6 140 Return 141 LoadFunc ismethod 142 LoadA ring_gettemp_var 0 143 PushV 60.4. Printing Final Intermediate Code 587
- 611. Ring Documentation, Release1.4.1 144 PushC sety 145 Call 0 146 NoOperation 147 PushV 148 JumpZ 167 149 NewLine 2 150 LoadA ring_gettemp_var 0 151 LoadMethod sety 152 LoadA ring_settemp_var 0 153 PushV 154 Call 0 1 155 AfterCallMethod 156 PushV 157 FreeStack 158 NewLine 3 159 LoadA ring_tempflag_var 0 163 160 AssignmentPointer 161 PushN 0.000000 162 BeforeEqual 0 163 Assignment 0 0 164 FreeStack 165 NewLine 4 166 Jump 175 167 NewLine 5 168 PushP 007D37D8 0 172 169 AssignmentPointer 170 PushN 1.000000 171 BeforeEqual 0 172 Assignment 0 0 173 FreeStack 174 NewLine 6 175 Return 176 LoadFunc ismethod 177 LoadA ring_gettemp_var 0 178 PushV 179 PushC setz 180 Call 0 181 NoOperation 182 PushV 183 JumpZ 202 184 NewLine 2 185 LoadA ring_gettemp_var 0 186 LoadMethod setz 187 LoadA ring_settemp_var 0 188 PushV 189 Call 0 1 190 AfterCallMethod 191 PushV 192 FreeStack 193 NewLine 3 194 LoadA ring_tempflag_var 0 198 195 AssignmentPointer 196 PushN 0.000000 197 BeforeEqual 0 198 Assignment 0 0 199 FreeStack 200 NewLine 4 201 Jump 210 60.4. Printing Final Intermediate Code 588
- 612. Ring Documentation, Release1.4.1 202 NewLine 5 203 PushP 007D37D8 0 207 204 AssignmentPointer 205 PushN 1.000000 206 BeforeEqual 0 207 Assignment 0 0 208 FreeStack 209 NewLine 6 210 Return =================================================== 60.5 CGI Support Command: ring test.ring -cgi 60.6 No Run Command: ring test.ring -norun 60.7 Printing Instruction Operation Code Command: ring test.ring -ins Output: =================================================== Operation : ReturnNull PC : 1 Line Number : 1 , File test.ring SP (After) : 0 - FuncSP : 0 LineNumber 1 =================================================== ..... ..... ..... Tip: Output removed from the previous example because it’s very large! 60.8 Performance Command: 60.5. CGI Support 589
- 613. Ring Documentation, Release1.4.1 ring test.ring -performance Output: =================================================== Date : 2015/09/15 Time : 15:56:17 Clock : 0 =================================================== Hello World 1 2 3 4 5 6 7 8 9 10 welcome x: 10.000000 y: 20.000000 z: 30.000000 =================================================== Date : 2015/09/15 Time : 15:56:17 Clock : 0 =================================================== 60.9 Generate Object File You can generate object file (.ringo) from your source code file (.ring) using -go option Tip: You will get one object file to use for distributing/running your application which may contains one or many ring source files that you can keep or distribute based on the application (commercial or open source). Command: ring test.ring -go To run the compiled object file ring test.ringo 60.9. Generate Object File 590
- 614. CHAPTER SIXTYONE LOW LEVEL FUNCTIONS Inthis chapter we will learn about the low level functions provided by Ring • callgc() • varptr() • space() • nullpointer() • object2pointer() • pointer2object() • ptrcmp() • ringvm_cfunctionslist() • ringvm_functionslist() • ringvm_classeslist() • ringvm_packageslist() • ringvm_memorylist() • ringvm_calllist() • ringvm_fileslist() 61.1 callgc() function Use this function to force calling the garbage collector during function execution when you use a loop that create temp. variables that you don’t free using the assignment operation. It’s very rare to need this function but it’s useful when you create something like event-loop for your game engine and start creating lists on the fly when you call functions. Example While True # process events # call functions using temp. lists like myfunc(["temp list"]) # call the garbage collector callgc() End 591
- 615. Ring Documentation, Release1.4.1 Tip: In Ring the garbage collector works automatically in the end of function execution or when you use the assign- ment statement. 61.2 varptr() function Use the varptr() function when you need to pass a pointer to a C/C++ function. Syntax: varptr(cVariableName,cPointerType) —> Low Level Object (C Pointer) example: r = 10 z = 20 see r + nl see varptr("r","int") see varptr("z","int") Output: 10 00E3C740 int 2 00E3BEC0 int 2 Note: the low level object is a list contains three items (The Pointer, The Type, The Status) 61.3 space() function Use the space function to allocate a specific number of bytes in Memory. Syntax: Space(nBytesCount) ---> String Example: mystring = space(200) See "String Size : " + len(mystring) + nl See "String : " + mystring + nl See "String Pointer : " See varptr("mystring","char *") Output: String Size : 200 String : String Pointer : 00FF8FE8 char * 2 61.2. varptr() function 592
- 616. Ring Documentation, Release1.4.1 Note: You may need the space() and VarPtr() functions to pass buffers to C functions. 61.4 nullpointer() function You may need to pass the NULL pointer to a C function that may expect a pointer as parameter and accept NULL pointers for optional parameters. Example: The next example uses the SDL_BlitSurface() function from the LibSDL Library through RingSDL The function accept SDL_Rect pointers in the second and the last parameter. Also the function accept NULL pointers, so we can pass them using the NULLPointer() Function. SDL_BlitSurface(text, nullpointer(), surface, nullpointer()) Note: The previous code doesn’t work alone, you need to learn how to use RingSDL first. Tip: We can pass NULL as parameter instead of using NULLPointer() 61.5 object2pointer() function Use this function to get a C pointer for Ring lists and objects Syntax: object2pointer(List|Object) --> Low Level Object ( C Pointer ) 61.6 pointer2object() function Use this function to get the Ring list and/or object from the low level object (C Pointer) Syntax: pointer2object(Low Level Object) ---> List|Object Example: # Create the list mylist = 1:5 # Create pointer to the list x = object2pointer(mylist) see x see nl # Add items to the list mylist + "welcome" # print the list items 61.4. nullpointer() function 593
- 617. Ring Documentation, Release1.4.1 y = pointer2object(x) see y Output: 0069A5D8 OBJECTPOINTER 0 1 2 3 4 5 welcome Note: In Ring the assignment operator copy lists and objects by value, to copy by reference Just use the ob- ject2pointer() and pointer2object() functions. Tip: The object2pointer() and pointer2object() are used in the stdlib - Tree Class implementation to create a reference for the parent node (object) in the child node (another object). 61.7 ptrcmp() function We can compare between two pointers (C Objects) using the ptrcmp() function. Syntax: ptrcmp(oObject1,oObject2) ---> value = 1 if oObject1 = oObject2 value = 0 if oObject1 != oObject2 Example: fp = fopen("ptrcmp.ring","r") fp2 = fp fp3 = fopen("ptrcmp.ring","r") see ptrcmp(fp,fp2) + nl see ptrcmp(fp,fp3) + nl fclose(fp) fclose(fp3) Output: 1 0 61.8 ringvm_cfunctionslist() function The Function return a list of functions written in C. Syntax: 61.7. ptrcmp() function 594
- 618. Ring Documentation, Release1.4.1 RingVM_CFunctionsList() ---> List Example: See RingVM_CFunctionsList() 61.9 ringvm_functionslist() function The Function return a list of functions written in Ring. Each List Member is a list contains the next items • Function Name • Program Counter (PC) - Function Position in Byte Code. • Source Code File Name • Private Flag (For Private Methods in Classes) Syntax: RingVM_FunctionsList() ---> List Example: test() func test see ringvm_functionslist() Output: test 8 B:/ring/tests/scripts/functionslist.ring 0 61.10 ringvm_classeslist() function The Function return a list of Classes. Each List Member is a list contains the next items • Class Name • Program Counter (PC) - Class Position in Byte Code. • Parent Class Name • Methods List • Flag (Is parent class information collected) • Pointer to the package (or NULL if no package is used) Syntax: RingVM_ClassesList() ---> List 61.9. ringvm_functionslist() function 595
- 619. Ring Documentation, Release1.4.1 Example: see ringvm_classeslist() class class1 func f1 class class2 from class1 class class3 from class1 Output: class1 9 f1 13 B:/ring/tests/scripts/classeslist.ring 0 0 00000000 class2 16 class1 0 00000000 class3 20 class1 0 00000000 61.11 ringvm_packageslist() function The Function return a list of Packages. Each List Member is a list contains the next items • Package Name • Classes List Syntax: RingVM_PackagesList() ---> List Example: see ringvm_packageslist() package package1 class class1 package package2 class class1 package package3 class class1 Output: 61.11. ringvm_packageslist() function 596
- 620. Ring Documentation, Release1.4.1 package1 class1 11 0 00FEF838 package2 class1 17 0 00FEF978 package3 class1 23 0 00FEFF68 61.12 ringvm_memorylist() function The Function return a list of Memory Scopes and Variables. Each List Member is a list contains variables in a different scope. Each Item in the scope list is a list contains the next items • Variable Name • Variable Type • Variable Value • Pointer Type (List/Item) if the value is a list • Private Flag (if the variable is an attribute in a Class) Syntax: RingVM_MemoryList() ---> List Example: x = 10 test() func test y = 20 see ringvm_memorylist() Output: true 2 1 0 0 false 2 0 0 61.12. ringvm_memorylist() function 597
- 621. Ring Documentation, Release1.4.1 0 nl 1 0 0 null 1 0 0 ring_gettemp_var 4 00000000 0 0 ccatcherror 1 NULL 0 0 ring_settemp_var 4 00000000 0 0 ring_tempflag_var 2 0 0 0 stdin 3 50512DB8 file 0 0 0 stdout 3 50512DD8 file 0 0 0 stderr 3 50512DF8 file 0 0 0 this 4 00000000 0 0 61.12. ringvm_memorylist() function 598
- 622. Ring Documentation, Release1.4.1 sysargv 3 B:ringbin/ring B:/ring/tests/scripts/memorylist.ring 0 0 x 2 10 0 0 y 2 20 0 0 61.13 ringvm_calllist() function The Function return a list of the functions call list. Each List Member is a list contains the next items • Function Type • Function Name • Program Counter (PC) • Stack Pointer (SP) • Temp. Memory List • Method or Function Flag • Caller PC • FuncExec Flag • ListStart Flag • Nested Lists Pointer • State List Syntax: RingVM_CallList() ---> List Example: hello() func hello test() func test mylist = ringvm_calllist() for t in mylist see t[2] + nl next Output: 61.13. ringvm_calllist() function 599
- 623. Ring Documentation, Release1.4.1 function hello() in file B:/ring/tests/scripts/calllist.ring called from line 1 function test() in file B:/ring/tests/scripts/calllist.ring called from line 3 ringvm_calllist 61.14 ringvm_fileslist() function Function return a list of the Ring Files. Syntax: RingVM_FilesList() ---> List Example: load "stdlib.ring" see ringvm_fileslist() Output: B:/ring/tests/scripts/fileslist.ring B:ringbinstdlib.ring eval stdlib.ring stdlib.rh stdclasses.ring stdfunctions.ring stdbase.ring stdstring.ring stdlist.ring stdstack.ring stdqueue.ring stdmath.ring stddatetime.ring stdfile.ring stdsystem.ring stddebug.ring stddatatype.ring stdconversion.ring stdodbc.ring stdmysql.ring stdsecurity.ring stdinternet.ring stdhashtable.ring stdtree.ring 61.14. ringvm_fileslist() function 600
- 624. CHAPTER SIXTYTWO INTRODUCTION In this chapterwe will learn about embedding Ring in Ring programs and applications. 62.1 Embedding Ring in Ring without sharing the State From Ring 1.0 we already have functions for embedding Ring in the C language. Also we can execute Ring code inside Ring programs using the eval() function. In this release we provide functions for embedding Ring in Ring programs without sharing the state. Advantages: 1. Quick integration for Ring programs and applications together without conflicts. 2. Execute and run Ring code in safe environments that we can trace. Example: pState = ring_state_init() ring_state_runcode(pState,"See 'Hello, World!'+nl") ring_state_runcode(pState,"x = 10") pState2 = ring_state_init() ring_state_runcode(pState2,"See 'Hello, World!'+nl") ring_state_runcode(pState2,"x = 20") ring_state_runcode(pState,"see x +nl") ring_state_runcode(pState2,"see x +nl") v1 = ring_state_findvar(pState,"x") v2 = ring_state_findvar(pState2,"x") see v1[3] + nl see V2[3] + nl ring_state_delete(pState) ring_state_delete(pState2) Output: Hello, World! Hello, World! 10 20 10 20 601
- 625. Ring Documentation, Release1.4.1 62.2 Serial Execution of Programs We can execute application after another application using ring_state_main() Example: chdir(exefolder()+"/../applications/formdesigner") ring_state_main('formdesigner.ring') chdir(exefolder()+"/../applications/cards") ring_state_main('cards.ring') 62.2. Serial Execution of Programs 602
- 626. CHAPTER SIXTYTHREE EXTENSION USING THEC/C++ LANGUAGES We can extend the Ring Virtual Machine (RingVM) by adding new functions written in the C programming language or C++. The RingVM comes with many functions written in C that we can call like any Ring function. We can extend the language by writing new functions then rebuilding the RingVM again, or we can create shared library (DLL/So) file to extend the RingVM without the need to rebuild it. The Ring language source code comes with two files to add new modules to the RingVM, ring_ext.h and ring_ext.c 63.1 ring_ext.h The file ring_ext.h contains constants that we can change to include/exclude modules during the build process. #ifndef ringext_h #define ringext_h /* Constants */ #define RING_VM_LISTFUNCS 1 #define RING_VM_REFMETA 1 #define RING_VM_MATH 1 #define RING_VM_FILE 1 #define RING_VM_OS 1 #define RING_VM_MYSQL 1 #define RING_VM_ODBC 1 #define RING_VM_OPENSSL 1 #define RING_VM_CURL 1 #define RING_VM_DLL 1 #endif 63.2 ring_ext.c The file ring_ext.c check constants defined in ring_ext.h before calling the start-up function in each module. Each module contains a function that register the module functions in the RingVM. #include "ring.h" void ring_vm_extension ( RingState *pRingState ) { /* Reflection and Meta-programming */ #if RING_VM_REFMETA ring_vm_refmeta_loadfunctions(pRingState); #endif 603
- 627. Ring Documentation, Release1.4.1 /* List Functions */ #if RING_VM_LISTFUNCS ring_vm_listfuncs_loadfunctions(pRingState); #endif /* Math */ #if RING_VM_MATH ring_vm_math_loadfunctions(pRingState); #endif /* File */ #if RING_VM_FILE ring_vm_file_loadfunctions(pRingState); #endif /* OS */ #if RING_VM_OS ring_vm_os_loadfunctions(pRingState); #endif /* MySQL */ #if RING_VM_MYSQL ring_vm_mysql_loadfunctions(pRingState); #endif /* ODBC */ #if RING_VM_ODBC ring_vm_odbc_loadfunctions(pRingState); #endif /* OPENSSL */ #if RING_VM_OPENSSL ring_vm_openssl_loadfunctions(pRingState); #endif /* CURL */ #if RING_VM_CURL ring_vm_curl_loadfunctions(pRingState); #endif /* DLL */ #if RING_VM_DLL ring_vm_dll_loadfunctions(pRingState); #endif } 63.3 Module Organization Each module starts by include the ring header file (ring.h). This files contains the Ring API that we can use to extend the RingVM. Each module comes with a function to register the module functions in the RingVM The registration is done by using ring_vm_funcregister() function. The ring_vm_funcregister() function takes two parameters, the first is the function name that will be used by Ring programs to call the function. The second parameter is the function pointer in the C program. for example, the ring_vmmath.c module contains the next code to register the module functions #include "ring.h" void ring_vm_math_loadfunctions ( RingState *pRingState ) { ring_vm_funcregister("sin",ring_vm_math_sin); ring_vm_funcregister("cos",ring_vm_math_cos); 63.3. Module Organization 604
- 628. Ring Documentation, Release1.4.1 ring_vm_funcregister("tan",ring_vm_math_tan); ring_vm_funcregister("asin",ring_vm_math_asin); ring_vm_funcregister("acos",ring_vm_math_acos); ring_vm_funcregister("atan",ring_vm_math_atan); ring_vm_funcregister("atan2",ring_vm_math_atan2); ring_vm_funcregister("sinh",ring_vm_math_sinh); ring_vm_funcregister("cosh",ring_vm_math_cosh); ring_vm_funcregister("tanh",ring_vm_math_tanh); ring_vm_funcregister("exp",ring_vm_math_exp); ring_vm_funcregister("log",ring_vm_math_log); ring_vm_funcregister("log10",ring_vm_math_log10); ring_vm_funcregister("ceil",ring_vm_math_ceil); ring_vm_funcregister("floor",ring_vm_math_floor); ring_vm_funcregister("fabs",ring_vm_math_fabs); ring_vm_funcregister("pow",ring_vm_math_pow); ring_vm_funcregister("sqrt",ring_vm_math_sqrt); ring_vm_funcregister("unsigned",ring_vm_math_unsigned); ring_vm_funcregister("decimals",ring_vm_math_decimals); ring_vm_funcregister("murmur3hash",ring_vm_math_murmur3hash); } Tip: Remember that the function ring_vm_math_loadfunctions() will be called by the ring_vm_extension() function (in the ring_ext.c file). 63.4 Function Structure Each module function may contains the next steps 1 - Check Parameters Count 2 - Check Parameters Type 3 - Get Parameters Values 4 - Execute Code/Call Functions 5 - Return Value The structure is very similar to any function (Input - Process - Output) But here we will use the Ring API for the steps 1,2,3 and 5. 63.5 Check Parameters Count We can check the parameters count using the RING_API_PARACOUNT macro. We can compare RING_API_PARACOUNT with any numeric value using == or != operators. Example: if ( RING_API_PARACOUNT != 1 ) { /* code */ } Example: 63.4. Function Structure 605
- 629. Ring Documentation, Release1.4.1 if ( RING_API_PARACOUNT == 1 ) { /* code */ } 63.6 Display Error Message We can display error messages using the RING_API_ERROR() function. The function will display the error and end the execution of the program. Note: the behaviour of this function can be changed by the Ring code using Try/Catch/Done statements, so in your C code, use Return after this function. Syntax: RING_API_ERROR(const char *cErrorMsg); The Ring API comes with some of predefined error messages that we can use #define RING_API_MISS1PARA "Bad parameters count, the function expect one parameter" #define RING_API_MISS2PARA "Bad parameters count, the function expect two parameters" #define RING_API_MISS3PARA "Bad parameters count, the function expect three parameters" #define RING_API_MISS4PARA "Bad parameters count, the function expect four parameters" #define RING_API_BADPARATYPE "Bad parameter type!" #define RING_API_BADPARACOUNT "Bad parameters count!" #define RING_API_BADPARARANGE "Bad parameters value, error in range!" #define RING_API_NOTPOINTER "Error in parameter, not pointer!" #define RING_API_NULLPOINTER "Error in parameter, NULL pointer!" #define RING_API_EMPTYLIST "Bad parameter, empty list!" 63.7 Check Parameters Type We can check the parameter type using the next functions int RING_API_ISNUMBER(int nParameterNumber); int RING_API_ISSTRING(int nParameterNumber); int RING_API_ISLIST(int nParameterNumber); int RING_API_ISPOINTER(int nParameterNumber); The output of these functions will be 1 (True) or 0 (False). 63.8 Get Parameters Values We can get paramters values using the next functions double RING_API_GETNUMBER(int nParameterNumber); const char *RING_API_GETSTRING(int nParameterNumber); int RING_API_GETSTRINGSIZE(int nParameterNumber); List *RING_API_GETLIST(int nParameterNumber); void *RING_API_GETCPOINTER(int nParameterNumber, const char *cPoinerType); int RING_API_GETPOINTERTYPE(int nParameterNumber); 63.6. Display Error Message 606
- 630. Ring Documentation, Release1.4.1 63.9 Return Value We can return values from our function using the next functions. RING_API_RETNUMBER(double nValue); RING_API_RETSTRING(const char *cString); RING_API_RETSTRING2(const char *cString,int nStringSize); RING_API_RETLIST(List *pList); RING_API_RETCPOINTER(void *pValue,const char *cPointerType); 63.10 Function Prototype When we define new function to be used for RingVM extension, we use the next prototype void my_function_name( void *pPointer ); or we can use the RING_FUNC() Macro RING_FUNC(my_function_name); 63.11 Sin() Function Implementation The next code represents the sin() function implementation using the Ring API and the sin() C function. void ring_vm_math_sin ( void *pPointer ) { if ( RING_API_PARACOUNT != 1 ) { RING_API_ERROR(RING_API_MISS1PARA); return ; } if ( RING_API_ISNUMBER(1) ) { RING_API_RETNUMBER(sin(RING_API_GETNUMBER(1))); } else { RING_API_ERROR(RING_API_BADPARATYPE); } } 63.12 Fopen() and Fclose() Functions Implementation The next code represents the fopen() function implementation using the Ring API and the fopen() C Function. The function takes two parameters, the first parameter is the file name as string. The second parameter is the mode as string. In the file ring_vmfile.h we have some constants to use as the pointer type like #define RING_VM_POINTER_FILE "file" #define RING_VM_POINTER_FILEPOS "filepos" The function implementation in ring_vmfile.c 63.9. Return Value 607
- 631. Ring Documentation, Release1.4.1 void ring_vm_file_fopen ( void *pPointer ) { FILE *fp ; if ( RING_API_PARACOUNT != 2 ) { RING_API_ERROR(RING_API_MISS2PARA); return ; } if ( RING_API_ISSTRING(1) && RING_API_ISSTRING(2) ) { fp = fopen(RING_API_GETSTRING(1),RING_API_GETSTRING(2)); RING_API_RETCPOINTER(fp,RING_VM_POINTER_FILE); } else { RING_API_ERROR(RING_API_BADPARATYPE); } } The next code represents the fclose() function implementation void ring_vm_file_fclose ( void *pPointer ) { FILE *fp ; if ( RING_API_PARACOUNT != 1 ) { RING_API_ERROR(RING_API_MISS1PARA); return ; } if ( RING_API_ISPOINTER(1) ) { fp = (FILE *) RING_API_GETCPOINTER(1,RING_VM_POINTER_FILE) ; if ( fp != NULL ) { RING_API_RETNUMBER(fclose(fp)); RING_API_SETNULLPOINTER(1); } } else { RING_API_ERROR(RING_API_BADPARATYPE); } } From fopen() and fclose() implementation we learned 1 - how to return C pointer using RING_API_RETCPOINTER() function 2 - how to check if the parameter is a pointer using the RING_API_ISPOINTER() function 3 - how to get C pointer value using the RING_API_GETCPOINTER() function 4 - how to set the C pointer variable (in RingVM) to NULL using the RING_API_SETNULLPOINTER() function 63.13 Ring API - List Functions In this section we will learn about the list functions provided by the Ring API to create new lists and manipulate the list items. List * ring_list_new ( int nSize ) ; void ring_list_newitem ( List *pList ) ; Item * ring_list_getitem ( List *pList,int index ) ; List * ring_list_delete ( List *pList ) ; void ring_list_deleteitem ( List *pList,int index ) ; void ring_list_print ( List *pList ) ; int ring_list_gettype ( List *pList, int index ) ; void ring_list_setint ( List *pList, int index ,int number ) ; 63.13. Ring API - List Functions 608
- 632. Ring Documentation, Release1.4.1 void ring_list_addint ( List *pList,int x ) ; void ring_list_setpointer ( List *pList, int index ,void *pValue ) ; void ring_list_addpointer ( List *pList,void *pValue ) ; void ring_list_setfuncpointer ( List *pList, int index ,void (*pFunc)(void *) ) ; void ring_list_addfuncpointer ( List *pList,void (*pFunc)(void *) ) ; int ring_list_isfuncpointer ( List *pList, int index ) ; void ring_list_setdouble ( List *pList, int index ,double number ) ; void ring_list_adddouble ( List *pList,double x ) ; void ring_list_setstring ( List *pList, int index ,const char *str ) ; void ring_list_setstring2 ( List *pList, int index ,const char *str,int nStrSize ) ; void ring_list_addstring ( List *pList,const char *str ) ; void ring_list_addstring2 ( List *pList,const char *str,int nStrSize ) ; List * ring_list_newlist ( List *pList ) ; List * ring_list_getlist ( List *pList, int index ) ; void ring_list_setlist ( List *pList, int index ) ; void ring_list_setactiveitem ( List *pList, Items *pItems, int index ) ; void ring_list_copy ( List *pNewList, List *pList ) ; int ring_list_isnumber ( List *pList, int index ) ; int ring_list_isstring ( List *pList, int index ) ; int ring_list_islist ( List *pList, int index ) ; int ring_list_ispointer ( List *pList, int index ) ; void ring_list_deleteallitems ( List *pList ) ; void ring_list_insertitem ( List *pList,int x ) ; void ring_list_insertint ( List *pList,int nPos,int x ) ; void ring_list_insertdouble ( List *pList,int nPos,double x ) ; void ring_list_insertpointer ( List *pList,int nPos,void *pValue ) ; void ring_list_insertstring ( List *pList,int nPos,const char *str ) ; void ring_list_insertstring2 ( List *pList,int nPos,const char *str,int nStrSize ) ; void ring_list_insertfuncpointer ( List *pList,int nPos,void (*pFunc)(void *) ) ; List * ring_list_insertlist ( List *pList,int nPos ) ; int ring_list_isiteminsidelist ( List *pList,Item *pItem ) ; int ring_list_findstring ( List *pList,const char *str,int nColumn ) ; int ring_list_finddouble ( List *pList,double nNum1,int nColumn ) ; void ring_list_sortnum ( List *pList,int left,int right,int nColumn ) ; void ring_list_sortstr ( List *pList,int left,int right,int nColumn ) ; int ring_list_binarysearchnum ( List *pList,double nNum1,int nColumn ) ; int ring_list_binarysearchstr ( List *pList,const char *cFind,int nColumn ) ; void ring_list_swap ( List *pList,int x,int y ) ; double ring_list_getdoublecolumn ( List *pList,int nIndex,int nColumn ) ; char * ring_list_getstringcolumn ( List *pList,int nIndex,int nColumn ) ; void ring_list_genarray ( List *pList ) ; void ring_list_deletearray ( List *pList ) ; void ring_list_genhashtable ( List *pList ) ; void ring_list_genhashtable2 ( List *pList ) ; void ring_list_refcopy ( List *pNewList, List *pList ) ; void ring_list_clear ( List *pList ) ; /* Macro */ ring_list_isdouble(pList,index) ring_list_isint(pList,index) ring_list_deletelastitem(x) ring_list_gethashtable(x) ring_list_getint(pList,index) ring_list_getpointer(pList,index) ring_list_getfuncpointer(pList,index) ring_list_callfuncpointer(pList,index,x) ring_list_getdouble(pList,index) ring_list_getstring(pList,index) ring_list_getstringobject(pList,index) 63.13. Ring API - List Functions 609
- 633. Ring Documentation, Release1.4.1 ring_list_getstringsize(pList,index) ring_list_getsize(x) (x->nSize) 63.14 Ring API - String Functions In this section we will learn about the string functions provided by the Ring API to create new string and manipulate the string content. String * ring_string_new ( const char *str ) ; String * ring_string_new2 ( const char *str,int nStrSize ) ; String * ring_string_delete ( String *pString ) ; int ring_string_size ( String *pString ) ; void ring_string_set ( String *pString,const char *str ) ; void ring_string_set2 ( String *pString,const char *str,int nStrSize ) ; void ring_string_add ( String *pString,const char *str ) ; void ring_string_add2 ( String *pString,const char *str,int nStrSize ) ; void ring_string_print ( String *pString ) ; void ring_string_setfromint ( String *pString,int x ) ; char * ring_string_lower ( char *cStr ) ; char * ring_string_upper ( char *cStr ) ; char * ring_string_lower2 ( char *cStr,int nStrSize ) ; char * ring_string_upper2 ( char *cStr,int nStrSize ) ; char * ring_string_find ( char *cStr1,char *cStr2 ) ; char * ring_string_find2 ( char *cStr1,int nStrSize1,char *cStr2,int nStrSize2 ) ; /* Macro */ ring_string_tolower(x) ring_string_toupper(x) ring_string_get(x) 63.15 MySQL_Columns() Function Implementation The next code presents the MySQL_Columns() function implementation. This function returns table columns information. void ring_vm_mysql_columns ( void *pPointer ) { MYSQL *con ; MYSQL_RES *result ; int nColumns,x ; MYSQL_ROW row ; MYSQL_FIELD *field ; List *pList, *pList2 ; if ( RING_API_PARACOUNT != 1 ) { RING_API_ERROR(RING_API_MISS1PARA); return ; } if ( RING_API_ISPOINTER(1) ) { con = (MYSQL *) RING_API_GETCPOINTER(1,RING_VM_POINTER_MYSQL) ; if ( con == NULL ) { return ; } result = mysql_store_result(con); if ( result == NULL ) { 63.14. Ring API - String Functions 610
- 634. Ring Documentation, Release1.4.1 RING_API_RETNUMBER(0); return ; } pList = RING_API_NEWLIST ; nColumns = mysql_num_fields(result); if ( row = mysql_fetch_row(result) ) { while ( field = mysql_fetch_field(result) ) { pList2 = ring_list_newlist(pList); ring_list_addstring(pList2,field->name); ring_list_adddouble(pList2,field->length); ring_list_adddouble(pList2,field->type); ring_list_adddouble(pList2,field->flags); } } mysql_free_result(result); RING_API_RETLIST(pList); } else { RING_API_ERROR(RING_API_BADPARATYPE); } } Lists are of type List, in the previoud function we declared two pointers of type List using List *pList, *pList2; Note: The function uses RING_API_NEWLIST to create new list instead of ring_list_new() to create the list in Temp. Memory related to the function scope. This way we can return the list from the function. Also we don’t delete the list, if it’s stored in a variable by Ring Code it will be saved, if not it will be automatically deleted by RingVM. The list can contains sub lists, we used the function ring_list_newlist() to create a sublist. The function ring_list_addstring() is used to add string items to the list/sublist. The function ring_list_adddouble() is used to add numeric items to the list/sublist. Note: All numeric items in lists returned from RingVM extension functions must be of type double and added to the list using ring_list_adddouble() function. We return the list from the extension function using the RING_API_RETLIST() function. 63.16 Dynamic/Shared Libraries (DLL/So) and LoadLib() function Instead of rebuilding the RingVM after writing new functions using C/C++ and the Ring API, we can create a DLL/So file and dynamically use the functions provided by this file in the runtime using the LoadLib() function. Dynamic library example in C #include "ring.h" RING_DLL __declspec(dllexport) RING_FUNC(ring_ringlib_dlfunc) { printf("Message from dlfunc"); } RING_DLL void ringlib_init(RingState *pRingState) { 63.16. Dynamic/Shared Libraries (DLL/So) and LoadLib() function 611
- 635. Ring Documentation, Release1.4.1 ring_vm_funcregister("dlfunc",ring_ringlib_dlfunc); } the idea is to create the ringlib_init() function, this function will be called by the RingVM when we use the generated DLL file though the LoadLib() function. Inside the ringlib_init() function we can register the module function or call a function that do the registration process for all of the module functions. The next Ring code demonstrates how to use the DLL library during the runtime. See "Dynamic DLL" + NL LoadLib("ringlib.dll") dlfunc() Output: Dynamic DLL Message from dlfunc 63.16. Dynamic/Shared Libraries (DLL/So) and LoadLib() function 612
- 636. CHAPTER SIXTYFOUR EMBEDDING RING LANGUAGEIN C/C++ PROGRAMS We can use the Ring language from C/C++ programs using the next functions RingState *ring_state_init(); ring_state_runcode(RingState *pState,const char *cCode); ring_state_delete(RingState *pState); 64.1 Ring State The idea is to use the ring_state_init() to create new state for the Ring Language then call the ring_state_runcode() function to execut Ring code using the same state. When we are done, we call the ring_state_delete() to free the memory. Example: #include "ring.h" #include "stdlib.h" int main(int argc, char *argv[]) { RingState *pState = ring_state_init(); printf("welcomen"); ring_state_runcode(pState,"see 'hello world from the ring programming language'+nl"); ring_state_delete(pState); } Output: welcome hello world from the ring programming language 64.2 Ring State Functions The Ring API comes with the next functions to create and delete the state. Also we have functions to create new variables and get variables values. RingState * ring_state_init ( void ) ; RingState * ring_state_delete ( RingState *pRingState ) ; void ring_state_runcode ( RingState *pRingState,const char *cStr ) ; List * ring_state_findvar ( RingState *pRingState,const char *cStr ) ; List * ring_state_newvar ( RingState *pRingState,const char *cStr ) ; void ring_state_main ( int argc, char *argv[] ) ; 613
- 637. Ring Documentation, Release1.4.1 void ring_state_runfile ( RingState *pRingState,const char *cFileName ) ; void ring_state_runobjectfile ( RingState *pRingState,const char *cFileName ) ; 64.3 Ring State Variables We can create more than one ring state in the same program and we can create and modify variable values. To get the variable list we can use the ring_state_findvar() function. To create new variable we can use the ring_state_newvar() function. Example: #include "ring.h" #include "stdlib.h" int main(int argc, char *argv[]) { List *pList; RingState *pState = ring_state_init(); RingState *pState2 = ring_state_init(); printf("welcomen"); ring_state_runcode(pState,"see 'hello world from the ring programming language'+nl"); printf("Again from C we will call ring coden"); ring_state_runcode(pState,"for x = 1 to 10 see x + nl next"); ring_state_runcode(pState2,"for x = 1 to 5 see x + nl next"); printf("Now we will display the x variable value from ring coden"); ring_state_runcode(pState,"see 'x value : ' + x + nl "); ring_state_runcode(pState2,"see 'x value : ' + x + nl "); pList = ring_state_findvar(pState,"x"); printf("Printing Ring variable value from C , %.0fn", ring_list_getdouble(pList,RING_VAR_VALUE)); printf("now we will set the ring variable value from Cn"); ring_list_setdouble(pList,RING_VAR_VALUE,20); ring_state_runcode(pState,"see 'x value after update : ' + x + nl "); pList = ring_state_newvar(pState,"v1"); ring_list_setdouble(pList,RING_VAR_VALUE,10); pList = ring_state_newvar(pState,"v2"); ring_list_setdouble(pList,RING_VAR_VALUE,20); ring_state_runcode(pState,"see 'v1 + v2 = ' see v1+v2 see nl"); ring_state_runcode(pState,"see 'end of test' + nl"); ring_state_delete(pState); 64.3. Ring State Variables 614
- 638. Ring Documentation, Release1.4.1 ring_state_delete(pState2); } Output: welcome hello world from the ring programming language Again from C we will call ring code 1 2 3 4 5 6 7 8 9 10 1 2 3 4 5 Now we will display the x variable value from ring code x value : 11 x value : 6 Printing Ring variable value from C , 11 now we will set the ring variable value from C x value after update : 20 v1 + v2 = 30 end of test 64.3. Ring State Variables 615
- 639. CHAPTER SIXTYFIVE CODE GENERATOR FORWRAPPING C/C++ LIBRARIES In this chapter we will learn how to use the code generator to wrap C/C++ Libraries to use it in our Ring applications. 65.1 Using the tool The code generator program is parsec.ring that can be executed as any ring code using the ring language. URL : https://github.com/ring-lang/ring/tree/master/extensions/codegen for example to read a configuration file called test.cf to generate the source code file test.c run parsec.ring as in the next command ring parsec.ring test.cf test.c 65.2 Configuration file The configuration file (*.cf) is the input file that we pass to the code generator. This file determine the functions prototypes that we need to use from a C/C++ library. Writing configuration files is simple according to the next rules 65.3 Using the function prototype • To generate code that wraps a C function, we just write the C function prototype Example: ALLEGRO_DISPLAY *al_create_display(int w, int h) void al_destroy_display(ALLEGRO_DISPLAY *display) int al_get_new_display_flags(void) void al_set_new_display_flags(int flags) int al_get_new_display_option(int option, int *importance) The previous example will guide the code generator to generate 5 functions that wraps the al_create_display(), al_destroy_display(), al_get_new_display_flags(), al_set_new_diplay_flas() and al_get_new_display_option() func- tions. The generated code will be as in the next example 616
- 640. Ring Documentation, Release1.4.1 RING_FUNC(ring_al_create_display) { if ( RING_API_PARACOUNT != 2 ) { RING_API_ERROR(RING_API_MISS2PARA); return ; } if ( ! RING_API_ISNUMBER(1) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } if ( ! RING_API_ISNUMBER(2) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } RING_API_RETCPOINTER(al_create_display( (int ) RING_API_GETNUMBER(1), (int ) RING_API_GETNUMBER(2)),"ALLEGRO_DISPLAY"); } RING_FUNC(ring_al_destroy_display) { if ( RING_API_PARACOUNT != 1 ) { RING_API_ERROR(RING_API_MISS1PARA); return ; } if ( ! RING_API_ISPOINTER(1) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } al_destroy_display((ALLEGRO_DISPLAY *) RING_API_GETCPOINTER(1,"ALLEGRO_DISPLAY")); } RING_FUNC(ring_al_get_new_display_flags) { if ( RING_API_PARACOUNT != 0 ) { RING_API_ERROR(RING_API_BADPARACOUNT); return ; } RING_API_RETNUMBER(al_get_new_display_flags()); } RING_FUNC(ring_al_set_new_display_flags) { if ( RING_API_PARACOUNT != 1 ) { RING_API_ERROR(RING_API_MISS1PARA); return ; } if ( ! RING_API_ISNUMBER(1) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } al_set_new_display_flags( (int ) RING_API_GETNUMBER(1)); } RING_FUNC(ring_al_get_new_display_option) 65.3. Using the function prototype 617
- 641. Ring Documentation, Release1.4.1 { if ( RING_API_PARACOUNT != 2 ) { RING_API_ERROR(RING_API_MISS2PARA); return ; } if ( ! RING_API_ISNUMBER(1) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } if ( ! RING_API_ISSTRING(2) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } RING_API_RETNUMBER(al_get_new_display_option( (int ) RING_API_GETNUMBER(1), RING_API_GETINTPOINTER(2))); RING_API_ACCEPTINTVALUE(2) ; } from the previous example we can see how much of time and effort is saved using the Code Generator. 65.4 Adding code to the generated code • To generate code directly type it between <code> and </code> Example : <code> /* some C code will be written here */ </code> We use this feature when we need to do something without the help of the code generator. for example including header files and defining constants using Macro. 65.5 Prefix for Functions Names • To determine a prefix in all of the functions names type it between <funcstart> and </funcstart> for ex- ample when we wrap the Allegro game programming library and we need all of the library functions to start with “al” we type the next code in the configuration file <funcstart> al </funcstart> 65.6 Generate function to wrap structures • To generate functions that wrap structures (create/delete/get structure members) just type the structures names between <struct> and </struct> also after the structure name you can type the structure members between { } separated by comma. Example 65.4. Adding code to the generated code 618
- 642. Ring Documentation, Release1.4.1 <struct> ALLEGRO_COLOR ALLEGRO_EVENT { type , keyboard.keycode , mouse.x , mouse.y } </struct> from the previous example we will generate two function to create/delete the structure ALLEGRO_COLOR Also we will generate two functions to create/delete the structure ALLEGRO_EVENT and four functions to get the structure ALLEGRO_EVENT members (type, keyboard.keycode, mouse.x, mouse.y). 65.7 Determine Structure Members Types You can determine the pointer name before the strucuture member name. Example: SDL_Surface {flags,SDL_PixelFormat *format,w,h,pitch,void *pixels,void *userdata,locked,void *lock_da 65.8 Defining Contants You can define constatants using <constant> and </constant> The generator will generate the required functions to get the constant values And will define the constants to be used with the same name in Ring code using *.rh file that will be generated too. rh = Ring Header Example: <constant> MIX_DEFAULT_FORMAT SDL_QUIT SDL_BUTTON_LEFT SDL_BUTTON_MIDDLE SDL_BUTTON_RIGHT </constant> Note: You will need to pass the *.rh file name to parsec.ring after the generated source file name. Example: ring ..codegenparsec.ring libsdl.cf ring_libsdl.c ring_libsdl.rh 65.9 Register New Functions We can register functions by typing the function prototype between <register> and </register> We need this feature only when we don’t provide the function prototype as input directly where we need to write the code of this function. Example: <register> void al_exit(void) </register> 65.7. Determine Structure Members Types 619
- 643. Ring Documentation, Release1.4.1 <code> RING_FUNC(ring_al_exit) { if ( RING_API_PARACOUNT != 0 ) { RING_API_ERROR(RING_API_BADPARACOUNT); return ; } exit(0); } </code> In the previous example we register the al_exit() function. This function is not part of the Allegro Library, it’s just an extra function that we need to add. Then the code if this function is written inside <code> and </code>. This function call the exit() function from the C language library. 65.10 Writing comments in the configuration file • To type comments just type it between <comment> and </comment> Example: <comment> configuration files </comment> 65.11 Executing code during code generation • To ask from the code generator to execute Ring code during reading the configuration file, just write the code between <runcode> and </runcode> Example: <runcode> aNumberTypes + "al_fixed" </runcode> The previoud line of code add the string “al_fixed” to the list aNumberTypes, This list contains types that can be considered as numbers when the code generator find it in the function prototype. 65.12 Enum and Numbers We have the list aEnumTypes to use for adding each Enumeration we uses in the functions prototype. Example: <runcode> aNumberTypes + "qreal" aNumberTypes + "qint64" aEnumTypes + "Qt::GestureType" aEnumTypes + "Qt::GestureFlag" </runcode> 65.10. Writing comments in the configuration file 620
- 644. Ring Documentation, Release1.4.1 65.13 Filtering using Expressions using <filter> and </filter> we can include/exclude parts of the configuration file based on a condition, for example <filter> iswindows() ... functions related to windows </filter> 65.14 Configuration file for the Allegro Library The next configuration file enable us to use the Allegro library functions. The configuration file size is less than 1000 lines. when the code generator take this file as input the generated source code file in the C language will be 12000 lines of code! We can see this configuration file as a complete example about using the code generator Also we can use it to know the functions that can be used from RingAllegro when you use it to create 2D games! <code> #define ALLEGRO_NO_MAGIC_MAIN #include <allegro5/allegro.h> #include "allegro5/allegro_image.h" #include <allegro5/allegro_font.h> #include <allegro5/allegro_ttf.h> #include <allegro5/allegro_audio.h> #include <allegro5/allegro_acodec.h> #include <allegro5/allegro_opengl.h> #include <allegro5/allegro_direct3d.h> #include <allegro5/allegro_color.h> #include <allegro5/allegro_memfile.h> #include "allegro5/allegro_native_dialog.h" #include <allegro5/allegro_physfs.h> #include <allegro5/allegro_primitives.h> </code> <funcstart> al </funcstart> <struct> ALLEGRO_EVENT { type , keyboard.keycode , mouse.x , mouse.y } ALLEGRO_TIMEOUT ALLEGRO_SAMPLE_ID ALLEGRO_COLOR </struct> <register> void al_exit(void) </register> <code> RING_FUNC(ring_al_exit) { if ( RING_API_PARACOUNT != 0 ) { RING_API_ERROR(RING_API_BADPARACOUNT); return ; 65.13. Filtering using Expressions 621
- 645. Ring Documentation, Release1.4.1 } exit(0); } </code> int al_init(void) <comment> configuration files </comment> <runcode> aNumberTypes + "al_fixed" </runcode> ALLEGRO_CONFIG *al_create_config(void) void al_destroy_config(ALLEGRO_CONFIG *config) ALLEGRO_CONFIG *al_load_config_file(const char *filename) ALLEGRO_CONFIG *al_load_config_file_f(ALLEGRO_FILE *file) bool al_save_config_file(const char *filename, const ALLEGRO_CONFIG *config) bool al_save_config_file_f(ALLEGRO_FILE *file, const ALLEGRO_CONFIG *config) void al_add_config_section(ALLEGRO_CONFIG *config, const char *name) Note: we just provided part of the configuration file, for complete copy check the Ring source code distribution. 65.15 Threads Support Next, another part of the configutaiton file, it’s important because we can learn from it how to add threads to our Ring applications by using a threads library. The idea is using ring_vm_mutexfunctions() and ring_vm_runcodefromthread() to execute Ring code. <comment> Threads </comment> <code> void *al_func_thread(ALLEGRO_THREAD *thread, void *pPointer) { List *pList; VM *pVM; const char *cStr; pList = (List *) pPointer ; pVM = (VM *) ring_list_getpointer(pList,2); cStr = ring_list_getstring(pList,1); ring_vm_runcodefromthread(pVM,cStr); ring_list_delete(pList); return NULL; } RING_FUNC(ring_al_create_thread) { ALLEGRO_THREAD *pThread; List *pList; if ( RING_API_PARACOUNT != 1 ) { 65.15. Threads Support 622
- 646. Ring Documentation, Release1.4.1 RING_API_ERROR(RING_API_MISS1PARA); return ; } if ( ! RING_API_ISSTRING(1) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } pList = ring_list_new(0); ring_list_addstring(pList,RING_API_GETSTRING(1)); ring_list_addpointer(pList,pPointer); ring_vm_mutexfunctions((VM *) pPointer,al_create_mutex, al_lock_mutex,al_unlock_mutex,al_destroy_mutex); pThread = al_create_thread(al_func_thread, pList); al_start_thread(pThread); RING_API_RETCPOINTER(pThread,"ALLEGRO_THREAD"); } RING_FUNC(ring_al_run_detached_thread) { List *pList; if ( RING_API_PARACOUNT != 1 ) { RING_API_ERROR(RING_API_MISS1PARA); return ; } if ( ! RING_API_ISSTRING(1) ) { RING_API_ERROR(RING_API_BADPARATYPE); return ; } pList = ring_list_new(0); ring_list_addstring(pList,RING_API_GETSTRING(1)); ring_list_addpointer(pList,pPointer); ring_vm_mutexfunctions((VM *) pPointer,al_create_mutex, al_lock_mutex,al_unlock_mutex,al_destroy_mutex); al_run_detached_thread(al_func_thread, pList); } </code> <register> ALLEGRO_THREAD *al_create_thread(void) void al_run_detached_thread(void) </register> void al_start_thread(ALLEGRO_THREAD *thread) void al_join_thread(ALLEGRO_THREAD *thread, void **ret_value) void al_set_thread_should_stop(ALLEGRO_THREAD *thread) bool al_get_thread_should_stop(ALLEGRO_THREAD *thread) void al_destroy_thread(ALLEGRO_THREAD *thread) ALLEGRO_MUTEX *al_create_mutex(void) ALLEGRO_MUTEX *al_create_mutex_recursive(void) void al_lock_mutex(ALLEGRO_MUTEX *mutex) void al_unlock_mutex(ALLEGRO_MUTEX *mutex) void al_destroy_mutex(ALLEGRO_MUTEX *mutex) ALLEGRO_COND *al_create_cond(void) void al_destroy_cond(ALLEGRO_COND *cond) void al_wait_cond(ALLEGRO_COND *cond, ALLEGRO_MUTEX *mutex) 65.15. Threads Support 623
- 647. Ring Documentation, Release1.4.1 65.16 Code Generator Rules for Wrapping C++ Classes • We can define classes between <class> and </class> • Between <class> and <class> we set attributes like “name, nonew, para, parent, codename, passvmpointer and abstract” • we set the attributes using the style attributename:value or attributename only if no values are required • The “name” attribute determine the class name in C++ code and this name will be the default name in the Ring code • The nonew instruction means that we don’t need new/delete methods • The parent attribute determine the parent class name • The codename attribute determine another class name in C++ code • The passvmpoint instruction means passing the Ring VM pointer to the class constructor when we create new objects, this happens when we set the codename attribute to a class the we will define and this class need the Virtual Machine pointer (for example to use it to execute Ring code from C++ code). • The abstract instruction means that no new method is required for this class “no objects will be created”. • Using <nodllstartup> we can avoid #include “ring.h”, We need this to write our startup code. • Using <libinitfunc> we can change the function name that register the library functions • Using <ignorecpointertype> we can ignore pointer type check • Using the aStringTypes list when can defined new types that treated like const char * • Using the aBeforeReturn list when can define code that is inserted after the variable name when we return that variable from a function • Using the aNewMethodName list we can define another method name to be used in Ring code when we call the C++ method. this feature is required because some C++ method may be identical to Ring Keywords like “load”,”next”,”end” and “done”. • in method prototype - when we use @ in the method name, we mean that we have the same method with different parameters (As in C++) 65.17 Using configuration file that wrap C++ Library To run the code generator to generate code for using C++ library in the Ring application, we can do that as we did with using C libraries but here we will generate .cpp file instead of *.c file. Also we will determine another file to be generated (.ring). This file will contains classes in Ring code that wraps C++ functions for using C++ classes and objects. ring parsec.ring qt.cf ring_qt.cpp ring_qt.ring 65.18 Configuration file for the Qt Framework The next configuration file is used to wrap many Qt classes The configuration file is around 3500 lines and generate C++ code around 56000 lines and generate also Ring code around 9000 lines. 65.16. Code Generator Rules for Wrapping C++ Classes 624
- 648. Ring Documentation, Release1.4.1 <nodllstartup> <libinitfunc> ring_qt_start <ignorecpointertype> <code> extern "C" { #include "ring.h" } #include "ring_qt.h" #include "gpushbutton.h" #include "gaction.h" #include "glineedit.h" #include "gtextedit.h" #include "glistwidget.h" #include "gtreeview.h" #include "gtreewidget.h" #include "gcombobox.h" #include "gtabwidget.h" #include "gtablewidget.h" #include "gprogressbar.h" #include "gspinbox.h" #include "gslider.h" #include "gdial.h" #include "gwebview.h" #include "gcheckbox.h" #include "gradiobutton.h" #include "gbuttongroup.h" #include "gvideowidget.h" #include "gtimer.h" #include "gtcpserver.h" #include "giodevice.h" #include "gabstractsocket.h" #include "gtcpsocket.h" #include "gcolordialog.h" #include "gallevents.h" #include <QApplication> #include <QObject> #include <QWidget> #include <QLabel> #include <QPixmap> #include <QIcon> #include <QSize> #include <QPushButton> #include <QMainWindow> #include <QVBoxLayout> #include <QHBoxLayout> #include <QLineEdit> #include <QTextEdit> #include <QListWidget> #include <QTreeView> #include <QDir> #include <QFileSystemModel> #include <QTreeWidget> #include <QTreeWidgetItem> 65.18. Configuration file for the Qt Framework 625
- 649. Ring Documentation, Release1.4.1 #include <QComboBox> #include <QVariant> #include <QMenuBar> #include <QMenu> #include <QToolBar> #include <QMainWindow> #include <QStatusBar> #include <QDockWidget> #include <QTabWidget> #include <QTableWidget> #include <QTableWidgetItem> #include <QSizePolicy> #include <QFrame> #include <QAbstractScrollArea> #include <QAbstractItemView> #include <QProgressBar> #include <QSpinBox> #include <QSlider> #include <QAbstractSlider> #include <QDateEdit> #include <QDateTimeEdit> #include <QAbstractSpinBox> #include <QDial> #include <QWebView> #include <QUrl> #include <QCheckBox> #include <QRadioButton> #include <QButtonGroup> #include <QMediaPlayer> #include <QMediaPlaylist> #include <QVideoWidget> #include <QPrinter> #include <QAction> #include <QEvent> #include <QMessageBox> #include <QTimer> #include <QFileDialog> #include <QPainter> #include <QPicture> #include <QPen> #include <QColor> #include <QPrinter> #include <QFont> #include <QWebSettings> #include <QBrush> #include <QByteArray> #include <QIODevice> #include <QAbstractSocket> #include <QTcpSocket> #include <QTcpServer> #include <QNetworkProxy> #include <QHostAddress> #include <QHostInfo> #include <QList> #include <QFileInfo> #include <QDirModel> #include <QModelIndex> #include <QFontDialog> 65.18. Configuration file for the Qt Framework 626
- 650. Ring Documentation, Release1.4.1 #include <QDialog> #include <QTextCursor> #include <QTextBlock> #include <QTextDocumentFragment> #include <QColorDialog> #include <QHeaderView> #include <QStringList> #include <QKeySequence> #include <QLCDNumber> #include <QInputDialog> #include <QDesktopWidget> #include <QRect> #include <QTextDocument> extern "C" { #define RING_DLL __declspec(dllexport) RING_DLL void ringlib_init(RingState *pRingState) { new QApplication(pRingState->argc,pRingState->argv); ring_qt_start(pRingState) ; } } </code> <runcode> aStringTypes + "QString" aBeforeReturn + ["QString",".toStdString().c_str()"] aNewMethodName + ["QWebView","load","loadpage"] aNewMethodName + ["QMediaPlaylist","load","loadfile"] aNewMethodName + ["QMediaPlaylist","next","movenext"] aNewMethodName + ["QPainter","end","endpaint"] aNewMethodName + ["QPicture","load","loadfile"] aNewMethodName + ["QLineEdit","end","endtext"] aNewMethodName + ["QDialog","done","donedialog"] aNewMethodName + ["QTextDocument","end","enddoc"] aNewMethodName + ["QTextBlock","next","nextblock"] </runcode> <class> name: qApp nonew </class> <register> void exec(void) void quit(void) void processEvents(void) </register> <code> RING_FUNC(ring_qApp_quit) { 65.18. Configuration file for the Qt Framework 627
- 651. Ring Documentation, Release1.4.1 qApp->quit(); } RING_FUNC(ring_qApp_exec) { qApp->exec(); } RING_FUNC(ring_qApp_processEvents) { qApp->processEvents(); } </code> <class> name: QObject para: void </class> bool blockSignals(bool block) QObjectList children(void) void dumpObjectInfo(void) void dumpObjectTree(void) bool inherits(const char *className) void installEventFilter(QObject *filterObj) bool isWidgetType(void) void killTimer(int id) void moveToThread(QThread *targetThread) QString objectName(void) QObject *parent(void) QVariant property(const char *name) void removeEventFilter(QObject *obj) void setObjectName(QString) void setParent(QObject *parent) bool setProperty(const char *name, QVariant) bool signalsBlocked(void) int startTimer(int interval) QThread *thread(void) void deleteLater(void) <class> name: QWidget para: void parent: QObject </class> bool acceptDrops(void) QString accessibleDescription(void) QString accessibleName(void) void activateWindow(void) void addAction(QAction *action) void adjustSize(void) bool autoFillBackground(void) int backgroundRole(void) QSize baseSize(void) QWidget *childAt(int x, int y) QRect childrenRect(void) 65.18. Configuration file for the Qt Framework 628
- 652. Ring Documentation, Release1.4.1 QRegion childrenRegion(void) void clearFocus(void) void clearMask(void) QMargins contentsMargins(void) QRect contentsRect(void) int contextMenuPolicy(void) QCursor cursor(void) int effectiveWinId(void) void ensurePolished(void) int focusPolicy(void) QWidget *focusProxy(void) QWidget *focusWidget(void) QFont font(void) QFontInfo fontInfo(void) QFontMetrics fontMetrics(void) int foregroundRole(void) QRect frameGeometry(void) QSize frameSize(void) QRect geometry(void) void getContentsMargins(int *left, int *top, int *right, int *bottom) void grabGesture(int gesture, int flags) void grabKeyboard(void) void grabMouse(void) int grabShortcut(QKeySequence , int context) QGraphicsEffect *graphicsEffect(void) QGraphicsProxyWidget *graphicsProxyWidget(void) bool hasFocus(void) bool hasMouseTracking(void) int height(void) int heightForWidth(int w) int inputMethodHints(void) QVariant inputMethodQuery(int query) void insertAction(QAction *before, QAction *action) bool isActiveWindow(void) bool isAncestorOf(QWidget *child) bool isEnabled(void) bool isEnabledTo(QWidget *ancestor) bool isFullScreen(void) bool isHidden(void) bool isMaximized(void) bool isMinimized(void) bool isModal(void) bool isVisible(void) bool isVisibleTo(QWidget *ancestor) bool isWindow(void) bool isWindowModified(void) QLayout *layout(void) int layoutDirection(void) QLocale locale(void) QPoint mapFrom(QWidget *parent, QPoint) QPoint mapFromGlobal(QPoint) QPoint mapFromParent(QPoint) QPoint mapTo(QWidget *parent, QPoint) QPoint mapToGlobal(QPoint pos) QPoint mapToParent(QPoint pos) QRegion mask(void) int maximumHeight(void) QSize maximumSize(void) 65.18. Configuration file for the Qt Framework 629
- 653. Ring Documentation, Release1.4.1 int maximumWidth(void) int minimumHeight(void) QSize minimumSize(void) int minimumWidth(void) void move(int x, int y) QWidget *nativeParentWidget(void) QWidget *nextInFocusChain(void) QRect normalGeometry(void) void overrideWindowFlags(int flags) QPalette palette(void) QWidget *parentWidget(void) QPoint pos(void) QWidget *previousInFocusChain(void) QRect rect(void) void releaseKeyboard(void) void releaseMouse(void) void releaseShortcut(int id) void removeAction(QAction *action) void render(QPaintDevice *target, QPoint,QRegion, int) void repaint(int x, int y, int w, int h) void resize(int w, int h) bool restoreGeometry(QByteArray) QByteArray saveGeometry(void) void scroll(int dx, int dy) void setAcceptDrops(bool on) void setAccessibleDescription(QString) void setAccessibleName(QString) void setAttribute(int attribute, bool on) void setAutoFillBackground(bool enabled) void setBackgroundRole(int role) void setBaseSize(int basew, int baseh) void setContentsMargins(int left, int top, int right, int bottom) void setContextMenuPolicy(int policy) void setCursor(QCursor) void setFixedHeight(int h) void setFixedSize(int w, int h) void setFixedWidth(int w) void setFocus(int reason) void setFocusPolicy(int policy) void setFocusProxy(QWidget *w) void setFont(QFont) void setForegroundRole(int role) void setGeometry(int x, int y, int w, int h) void setGraphicsEffect(QGraphicsEffect *effect) void setInputMethodHints(int hints) void setLayout(QLayout *layout) void setLayoutDirection(int direction) void setLocale(QLocale) void setMask(QBitmap) void setMaximumHeight(int maxh) void setMaximumSize(int maxw, int maxh) void setMaximumWidth(int maxw) void setMinimumHeight(int minh) void setMinimumSize(int minw, int minh) void setMinimumWidth(int minw) void setMouseTracking(bool enable) void setPalette(QPalette) void setParent(QWidget *parent) 65.18. Configuration file for the Qt Framework 630
- 654. Ring Documentation, Release1.4.1 void setShortcutAutoRepeat(int id, bool enable) void setShortcutEnabled(int id, bool enable) void setSizeIncrement(int w, int h) void setSizePolicy(int horizontal, int vertical) void setStatusTip(QString) void setStyle(QStyle *style) void setToolTip(QString) void setUpdatesEnabled(bool enable) void setWhatsThis(QString) void setWindowFilePath(QString) void setWindowFlags(int type) void setWindowIcon(QIcon) void setWindowIconText(QString) void setWindowModality(int windowModality) void setWindowOpacity(double level) void setWindowRole(QString) void setWindowState(int windowState) QSize size(void) QSize sizeIncrement(void) QSizePolicy sizePolicy(void) void stackUnder(QWidget *w) QString statusTip(void) QStyle *style(void) QString styleSheet(void) bool testAttribute(int attribute) QString toolTip(void) bool underMouse(void) void ungrabGesture(int gesture) void unsetCursor(void) void unsetLayoutDirection(void) void unsetLocale(void) void update(int x, int y, int w, int h) void updateGeometry(void) bool updatesEnabled(void) QRegion visibleRegion(void) QString whatsThis(void) int width(void) int winId(void) QWidget *window(void) QString windowFilePath(void) int windowFlags(void) QIcon windowIcon(void) QString windowIconText(void) int windowModality(void) double windowOpacity(void) QString windowRole(void) int windowState(void) QString windowTitle(void) int windowType(void) int x(void) int y(void) bool close(void) void hide(void) void lower(void) void raise(void) void setDisabled(bool disable) void setEnabled(bool) void setHidden(bool hidden) 65.18. Configuration file for the Qt Framework 631
- 655. Ring Documentation, Release1.4.1 void setStyleSheet(QString) void setWindowModified(bool) void setWindowTitle(QString) void show(void) void showFullScreen(void) void showMaximized(void) void showMinimized(void) void showNormal(void) QWidget *find(int id) QWidget *keyboardGrabber(void) QWidget *mouseGrabber(void) void setTabOrder(QWidget *first, QWidget *second) <class> name: QLabel para: QWidget * parent: QWidget </class> int alignment(void) QWidget *buddy(void) bool hasScaledContents(void) bool hasSelectedText(void) int indent(void) int margin(void) QMovie *movie(void) bool openExternalLinks(void) QPicture *picture(void) QPixmap *pixmap(void) QString selectedText(void) int selectionStart(void) void setAlignment(int) void setBuddy(QWidget *buddy) void setIndent(int) void setMargin(int) void setOpenExternalLinks(bool open) void setScaledContents(bool) void setSelection(int start, int length) void setTextFormat(int) void setTextInteractionFlags(int flags) void setWordWrap(bool on) QString text(void) int textFormat(void) int textInteractionFlags(void) bool wordWrap(void) void clear(void) void setMovie(QMovie *movie) void setNum(double num) void setPicture(QPicture) void setPixmap(QPixmap) void setText(QString) <class> name: QPushButton para: QWidget * parent: QWidget codename: GPushButton passvmpointer 65.18. Configuration file for the Qt Framework 632
- 656. Ring Documentation, Release1.4.1 </class> void setText(const char *) void setClickEvent(const char *) void setIcon(QIcon) void setIconSize(QSize) <class> name: QLineEdit para: QWidget * parent: QWidget codename: GLineEdit passvmpointer </class> int alignment(void) void backspace(void) QCompleter *completer(void) QMenu *createStandardContextMenu(void) void cursorBackward(bool mark, int steps) void cursorForward(bool mark, int steps) int cursorMoveStyle(void) int cursorPosition(void) int cursorPositionAt(QPoint) void cursorWordBackward(bool mark) void cursorWordForward(bool mark) void del(void) void deselect(void) QString displayText(void) bool dragEnabled(void) int echoMode(void) void end(bool mark) void getTextMargins(int *left, int *top, int *right, int *bottom) bool hasAcceptableInput(void) bool hasFrame(void) bool hasSelectedText(void) void home(bool mark) QString inputMask(void) void insert(QString) bool isModified(void) bool isReadOnly(void) bool isRedoAvailable(void) bool isUndoAvailable(void) int maxLength(void) QString placeholderText(void) QString selectedText(void) int selectionStart(void) void setAlignment(int flag) void setCompleter(QCompleter *c) void setCursorMoveStyle(int style) void setCursorPosition(int) void setDragEnabled(bool b) void setEchoMode(int) void setFrame(bool) void setInputMask(QString) void setMaxLength(int) void setModified(bool) void setPlaceholderText(QString) 65.18. Configuration file for the Qt Framework 633
- 657. Ring Documentation, Release1.4.1 void setReadOnly(bool) void setSelection(int start, int length) void setTextMargins(int left, int top, int right, int bottom) void setValidator(QValidator *v) QString text(void) QMargins textMargins(void) QValidator *validator(void) void clear(void) void copy(void) void cut(void) void paste(void) void redo(void) void selectAll(void) void setText(QString) void undo(void) void setTextChangedEvent(const char *) void setcursorPositionChangedEvent(const char *) void seteditingFinishedEvent(const char *) void setreturnPressedEvent(const char *) void setselectionChangedEvent(const char *) void settextEditedEvent(const char *) Note: Most of the content of the previous configuration file is removed from this documentation, for a complete version see the Ring source code distribution. 65.19 Configuration Files Examples You can learn from the next examples • RingAllegro : https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/allegro.cf • RingQt : https://github.com/ring-lang/ring/blob/master/extensions/ringqt/qt.cf • RingLibSDL : https://github.com/ring-lang/ring/blob/master/extensions/ringsdl/libsdl.cf After modifing the configuration file, You will need to generate the code, You can learn from the next examples • RingAllegro : https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/gencode.bat • RingQt : https://github.com/ring-lang/ring/blob/master/extensions/ringqt/gencode.bat • RingLibSDL : https://github.com/ring-lang/ring/blob/master/extensions/ringsdl/gencode.bat After generating the code, You will need to build the library, You can learn from the next examples • RingAllegro : https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/buildvc.bat • RingQt : https://github.com/ring-lang/ring/blob/master/extensions/ringqt/buildmingw32.bat • RingLibSDL : https://github.com/ring-lang/ring/blob/master/extensions/ringsdl/buildvc.bat 65.19. Configuration Files Examples 634
- 658. CHAPTER SIXTYSIX RINGLIBCURL FUNCTIONS REFERENCE •CURL *curl_easy_init(void) • void curl_easy_cleanup(CURL * handle ) • CURLcode curl_easy_setopt(CURL *handle, CURLoption option, PARAMETER) • CURLcode curl_easy_setopt_1(CURL *handle, CURLoption option, int) • CURLcode curl_easy_setopt_2(CURL *handle, CURLoption option, const char *) • CURLcode curl_easy_setopt_3(CURL *handle, CURLoption option, void *) • CURLcode curl_easy_setopt_4(CURL *handle, CURLoption option, CURLLIST *) • CURLcode curl_easy_perform(CURL * easy_handle ) • String *curl_easy_perform_silent(CURL * easy_handle ) • CURLcode curl_easy_getinfo_1(CURL *handle, CURLINFO info, char **urlp) • CURLcode curl_easy_getinfo_2(CURL *handle, CURLINFO info, long *codep) • CURLcode curl_easy_getinfo_3(CURL *handle, CURLINFO info, double *timep) • CURLcode curl_easy_getinfo_4(CURL *handle, CURLINFO info, CURLLIST **engine_list) • CURLcode curl_easy_getinfo_5(CURL *handle, CURLINFO info, struct curl_certinfo *chainp) • CURLcode curl_easy_getinfo_6(CURL *handle, CURLINFO info, struct curl_tlssessioninfo **session) • char *curl_version(void) • time_t curl_getdate(char * datestring , time_t *now ) • CURLFORMcode curl_formadd_1(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, const char *, CURLformoption) • CURLFORMcode curl_formadd_2(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, const char *,CURLformoption, const char *, CURLformoption) • CURLFORMcode curl_formadd_3(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, void *, CURLformoption) • CURLFORMcode curl_formadd_4(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, void *,CURLformoption, long , CURLformoption) • CURLFORMcode curl_formadd_5(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char , CURLformoption, void *,CURLformoption, long , CURLformoption, const char , CURL- formoption) 635
- 659. Ring Documentation, Release1.4.1 • CURLFORMcode curl_formadd_6(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, const char *,CURLformoption, void * , CURLformoption, long , CURLformoption) • CURLFORMcode curl_formadd_7(struct curl_httppost **firstitem, struct curl_httppost **lastitem, CURLfor- moption, const char *, CURLformoption, struct curl_forms [], CURLformoption) • void curl_formfree(struct curl_httppost * form) • CURLLIST *curl_slist_append(CURLLIST * list, const char * string ) • void curl_slist_free_all(CURLLIST * list) • char *curl_easy_escape( CURL * curl , const char * string , int length ) • char *curl_easy_unescape( CURL * curl , const char * url , int inlength , int * outlength ) 636
- 660. CHAPTER SIXTYSEVEN RINGLIBZIP FUNCTIONS REFERENCE •ZIP_T *zip_openfile(const char *, const char *) • int zip_entry_open(ZIP_T*, const char *) • int zip_entry_write(ZIP_T*, const char *,int) • int zip_entry_fwrite(ZIP_T*, const char *) • int zip_entry_read(ZIP_T*, void *, size_t *) • int zip_entry_fread(ZIP_T*, const char *cFile) • int zip_entry_close(ZIP_T*) • void zip_extract_file(const char *cZIPFile,const char *cFile) • void zip_extract_allfiles(const char *cFile, const char *cFolder) • void zip_close(ZIP_T*) • int zip_filescount(ZIP_T *) • const char *zip_getfilenamebyindex(ZIP_T *pZip,int index) 637
- 661. CHAPTER SIXTYEIGHT RINGALLEGRO FUNCTIONS REFERENCE •void al_exit(void) • void al_run_main(void) • int al_init(void) • ALLEGRO_CONFIG *al_create_config(void) • void al_destroy_config(ALLEGRO_CONFIG *config) • ALLEGRO_CONFIG *al_load_config_file(const char *filename) • ALLEGRO_CONFIG *al_load_config_file_f(ALLEGRO_FILE *file) • bool al_save_config_file(const char *filename, const ALLEGRO_CONFIG *config) • bool al_save_config_file_f(ALLEGRO_FILE *file, const ALLEGRO_CONFIG *config) • void al_add_config_section(ALLEGRO_CONFIG *config, const char *name) • void al_add_config_comment(ALLEGRO_CONFIG *config, const char *section, const char *comment) • const char *al_get_config_value(const ALLEGRO_CONFIG *config,const char *section, const char *key) • void al_set_config_value(ALLEGRO_CONFIG *config,const char *section, const char *key, const char *value) • char const *al_get_first_config_section(ALLEGRO_CONFIG const *config,ALLEGRO_CONFIG_SECTION **iterator) • char const *al_get_next_config_section(ALLEGRO_CONFIG_SECTION **iterator) • char const *al_get_first_config_entry(ALLEGRO_CONFIG const *config,char const *section, ALLE- GRO_CONFIG_ENTRY **iterator) • char const *al_get_next_config_entry(ALLEGRO_CONFIG_ENTRY **iterator) • ALLEGRO_CONFIG *al_merge_config(const ALLEGRO_CONFIG *cfg1,const ALLEGRO_CONFIG *cfg2) • void al_merge_config_into(ALLEGRO_CONFIG *master, const ALLEGRO_CONFIG *add) • ALLEGRO_DISPLAY *al_create_display(int w, int h) • void al_destroy_display(ALLEGRO_DISPLAY *display) • int al_get_new_display_flags(void) • void al_set_new_display_flags(int flags) • int al_get_new_display_option(int option, int *importance) • void al_set_new_display_option(int option, int value, int importance) • void al_reset_new_display_options(void) 638
- 662. Ring Documentation, Release1.4.1 • void al_get_new_window_position(int *x, int *y) • void al_set_new_window_position(int x, int y) • int al_get_new_display_refresh_rate(void) • void al_set_new_display_refresh_rate(int refresh_rate) • ALLEGRO_EVENT_SOURCE *al_get_display_event_source(ALLEGRO_DISPLAY *display) • ALLEGRO_BITMAP *al_get_backbuffer(ALLEGRO_DISPLAY *display) • void al_flip_display(void) • void al_update_display_region(int x, int y, int width, int height) • bool al_wait_for_vsync(void) • int al_get_display_width(ALLEGRO_DISPLAY *display) • int al_get_display_height(ALLEGRO_DISPLAY *display) • bool al_resize_display(ALLEGRO_DISPLAY *display, int width, int height) • bool al_acknowledge_resize(ALLEGRO_DISPLAY *display) • void al_get_window_position(ALLEGRO_DISPLAY *display, int *x, int *y) • void al_set_window_position(ALLEGRO_DISPLAY *display, int x, int y) • int al_get_display_flags(ALLEGRO_DISPLAY *display) • bool al_set_display_flag(ALLEGRO_DISPLAY *display, int flag, bool onoff) • int al_get_display_option(ALLEGRO_DISPLAY *display, int option) • int al_get_display_format(ALLEGRO_DISPLAY *display) • int al_get_display_refresh_rate(ALLEGRO_DISPLAY *display) • void al_set_window_title(ALLEGRO_DISPLAY *display, const char *title) • void al_set_display_icon(ALLEGRO_DISPLAY *display, ALLEGRO_BITMAP *icon) • void al_set_display_icons(ALLEGRO_DISPLAY *display,int num_icons, ALLEGRO_BITMAP *icons[]) • bool al_inhibit_screensaver(bool inhibit) • void al_acknowledge_drawing_halt(ALLEGRO_DISPLAY *display) • void al_acknowledge_drawing_resume(ALLEGRO_DISPLAY *display) • int al_get_display_orientation(ALLEGRO_DISPLAY* display) • void al_set_display_option(ALLEGRO_DISPLAY *display, int option, int value) • bool al_get_window_constraints(ALLEGRO_DISPLAY *display,int *min_w, int *min_h, int *max_w, int *max_h) • bool al_set_window_constraints(ALLEGRO_DISPLAY *display,int min_w, int min_h, int max_w, int max_h) • ALLEGRO_EVENT_QUEUE *al_create_event_queue(void) • void al_destroy_event_queue(ALLEGRO_EVENT_QUEUE *queue) • void al_register_event_source(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT_SOURCE *source) • void al_unregister_event_source(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT_SOURCE *source) • bool al_is_event_queue_empty(ALLEGRO_EVENT_QUEUE *queue) 639
- 663. Ring Documentation, Release1.4.1 • bool al_get_next_event(ALLEGRO_EVENT_QUEUE *queue, ALLEGRO_EVENT *ret_event) • bool al_peek_next_event(ALLEGRO_EVENT_QUEUE *queue, ALLEGRO_EVENT *ret_event) • bool al_drop_next_event(ALLEGRO_EVENT_QUEUE *queue) • void al_flush_event_queue(ALLEGRO_EVENT_QUEUE *queue) • void al_wait_for_event(ALLEGRO_EVENT_QUEUE *queue, ALLEGRO_EVENT *ret_event) • bool al_wait_for_event_timed(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT *ret_event, float secs) • bool al_wait_for_event_until(ALLEGRO_EVENT_QUEUE *queue,ALLEGRO_EVENT *ret_event, ALLE- GRO_TIMEOUT *timeout) • void al_init_user_event_source(ALLEGRO_EVENT_SOURCE *src) • void al_destroy_user_event_source(ALLEGRO_EVENT_SOURCE *src) • intptr_t al_get_event_source_data(const ALLEGRO_EVENT_SOURCE *source) • void al_set_event_source_data(ALLEGRO_EVENT_SOURCE *source, intptr_t data) • ALLEGRO_FILE *al_fopen(const char *path, const char *mode) • ALLEGRO_FILE *al_fopen_interface(const ALLEGRO_FILE_INTERFACE *drv,const char *path, const char *mode) • ALLEGRO_FILE *al_fopen_slice(ALLEGRO_FILE *fp, size_t initial_size, const char *mode) • void al_fclose(ALLEGRO_FILE *f) • size_t al_fread(ALLEGRO_FILE *f, void *ptr, size_t size) • size_t al_fwrite(ALLEGRO_FILE *f, const void *ptr, size_t size) • bool al_fflush(ALLEGRO_FILE *f) • int64_t al_ftell(ALLEGRO_FILE *f) • bool al_fseek(ALLEGRO_FILE *f, int64_t offset, int whence) • bool al_feof(ALLEGRO_FILE *f) • bool al_ferror(ALLEGRO_FILE *f) • void al_fclearerr(ALLEGRO_FILE *f) • int al_fungetc(ALLEGRO_FILE *f, int c) • int64_t al_fsize(ALLEGRO_FILE *f) • int al_fgetc(ALLEGRO_FILE *f) • int al_fputc(ALLEGRO_FILE *f, int c) • int16_t al_fread16le(ALLEGRO_FILE *f) • int16_t al_fread16be(ALLEGRO_FILE *f) • size_t al_fwrite16le(ALLEGRO_FILE *f, int16_t w) • size_t al_fwrite16be(ALLEGRO_FILE *f, int16_t w) • int32_t al_fread32le(ALLEGRO_FILE *f) • int32_t al_fread32be(ALLEGRO_FILE *f) • size_t al_fwrite32le(ALLEGRO_FILE *f, int32_t l) 640
- 664. Ring Documentation, Release1.4.1 • size_t al_fwrite32be(ALLEGRO_FILE *f, int32_t l) • char *al_fgets(ALLEGRO_FILE *f, char * const buf, size_t max) • ALLEGRO_USTR *al_fget_ustr(ALLEGRO_FILE *f) • int al_fputs(ALLEGRO_FILE *f, char const *p) • ALLEGRO_FILE *al_fopen_fd(int fd, const char *mode) • ALLEGRO_FILE *al_make_temp_file(const char *template, ALLEGRO_PATH **ret_path) • void al_set_new_file_interface(const ALLEGRO_FILE_INTERFACE *file_interface • void al_set_standard_file_interface(void) • const ALLEGRO_FILE_INTERFACE *al_get_new_file_interface(void) • ALLEGRO_FILE *al_create_file_handle(const ALLEGRO_FILE_INTERFACE *drv,void *userdata) • void *al_get_file_userdata(ALLEGRO_FILE *f) • ALLEGRO_FS_ENTRY *al_create_fs_entry(const char *path) • void al_destroy_fs_entry(ALLEGRO_FS_ENTRY *fh) • const char *al_get_fs_entry_name(ALLEGRO_FS_ENTRY *e) • bool al_update_fs_entry(ALLEGRO_FS_ENTRY *e) • uint32_t al_get_fs_entry_mode(ALLEGRO_FS_ENTRY *e) • time_t al_get_fs_entry_atime(ALLEGRO_FS_ENTRY *e) • time_t al_get_fs_entry_ctime(ALLEGRO_FS_ENTRY *e) • time_t al_get_fs_entry_mtime(ALLEGRO_FS_ENTRY *e) • off_t al_get_fs_entry_size(ALLEGRO_FS_ENTRY *e) • bool al_fs_entry_exists(ALLEGRO_FS_ENTRY *e) • bool al_remove_fs_entry(ALLEGRO_FS_ENTRY *e) • bool al_filename_exists(const char *path) • bool al_remove_filename(const char *path) • bool al_open_directory(ALLEGRO_FS_ENTRY *e) • ALLEGRO_FS_ENTRY *al_read_directory(ALLEGRO_FS_ENTRY *e) • bool al_close_directory(ALLEGRO_FS_ENTRY *e) • char *al_get_current_directory(void) • bool al_change_directory(const char *path) • bool al_make_directory(const char *path) • ALLEGRO_FILE *al_open_fs_entry(ALLEGRO_FS_ENTRY *e, const char *mode) • void al_set_fs_interface(const ALLEGRO_FS_INTERFACE *fs_interface) • void al_set_standard_fs_interface(void) • const ALLEGRO_FS_INTERFACE *al_get_fs_interface(void) • al_fixed al_itofix(int x); • int al_fixtoi(al_fixed x); 641
- 665. Ring Documentation, Release1.4.1 • int al_fixfloor(al_fixed x); • int al_fixceil(al_fixed x); • al_fixed al_ftofix(double x); • double al_fixtof(al_fixed x); • al_fixed al_fixmul(al_fixed x, al_fixed y); • al_fixed al_fixdiv(al_fixed x, al_fixed y); • al_fixed al_fixadd(al_fixed x, al_fixed y); • al_fixed al_fixsub(al_fixed x, al_fixed y); • al_fixed al_fixsin(al_fixed x); • al_fixed al_fixcos(al_fixed x); • al_fixed al_fixtan(al_fixed x); • al_fixed al_fixasin(al_fixed x); • al_fixed al_fixacos(al_fixed x); • al_fixed al_fixatan(al_fixed x) • al_fixed al_fixatan2(al_fixed y, al_fixed x) • al_fixed al_fixsqrt(al_fixed x) • al_fixed al_fixhypot(al_fixed x, al_fixed y) • ALLEGRO_DISPLAY_MODE *al_get_display_mode(int index, ALLEGRO_DISPLAY_MODE *mode) • int al_get_num_display_modes(void) • ALLEGRO_COLOR al_map_rgb(unsigned char r, unsigned char g, unsigned char b) • ALLEGRO_COLOR al_map_rgb_f(float r, float g, float b) • ALLEGRO_COLOR al_map_rgba(unsigned char r, unsigned char g, unsigned char b, unsigned char a) • ALLEGRO_COLOR al_map_rgba_f(float r, float g, float b, float a) • void al_unmap_rgb(ALLEGRO_COLOR color,unsigned char *r, unsigned char *g, unsigned char *b) • void al_unmap_rgb_f(ALLEGRO_COLOR color, float *r, float *g, float *b) • void al_unmap_rgba(ALLEGRO_COLOR color,unsigned char *r, unsigned char *g, unsigned char *b, unsigned char *a) • void al_unmap_rgba_f(ALLEGRO_COLOR color,float *r, float *g, float *b, float *a) • int al_get_pixel_size(int format) • int al_get_pixel_format_bits(int format) • ALLEGRO_LOCKED_REGION *al_lock_bitmap(ALLEGRO_BITMAP *bitmap,int format, int flags) • ALLEGRO_LOCKED_REGION *al_lock_bitmap_region(ALLEGRO_BITMAP *bitmap,int x, int y, int width, int height, int format, int flags) • void al_unlock_bitmap(ALLEGRO_BITMAP *bitmap) • ALLEGRO_BITMAP *al_create_bitmap(int w, int h) • ALLEGRO_BITMAP *al_create_sub_bitmap(ALLEGRO_BITMAP *parent,int x, int y, int w, int h) • ALLEGRO_BITMAP *al_clone_bitmap(ALLEGRO_BITMAP *bitmap) 642
- 666. Ring Documentation, Release1.4.1 • void al_destroy_bitmap(ALLEGRO_BITMAP *bitmap) • int al_get_new_bitmap_flags(void) • int al_get_new_bitmap_format(void) • void al_set_new_bitmap_flags(int flags) • void al_add_new_bitmap_flag(int flag) • void al_set_new_bitmap_format(int format) • int al_get_bitmap_flags(ALLEGRO_BITMAP *bitmap) • int al_get_bitmap_format(ALLEGRO_BITMAP *bitmap) • int al_get_bitmap_height(ALLEGRO_BITMAP *bitmap) • int al_get_bitmap_width(ALLEGRO_BITMAP *bitmap) • ALLEGRO_COLOR al_get_pixel(ALLEGRO_BITMAP *bitmap, int x, int y) • bool al_is_bitmap_locked(ALLEGRO_BITMAP *bitmap) • bool al_is_compatible_bitmap(ALLEGRO_BITMAP *bitmap) • bool al_is_sub_bitmap(ALLEGRO_BITMAP *bitmap) • ALLEGRO_BITMAP *al_get_parent_bitmap(ALLEGRO_BITMAP *bitmap) • void al_clear_to_color(ALLEGRO_COLOR color) • void al_draw_bitmap(ALLEGRO_BITMAP *bitmap, float dx, float dy, int flags) • void al_draw_tinted_bitmap(ALLEGRO_BITMAP *bitmap, ALLEGRO_COLOR tint,float dx, float dy, int flags) • void al_draw_bitmap_region(ALLEGRO_BITMAP *bitmap,float sx, float sy, float sw, float sh, float dx, float dy, int flags) • void al_draw_tinted_bitmap_region(ALLEGRO_BITMAP *bitmap,ALLEGRO_COLOR tint,float sx, float sy, float sw, float sh, float dx, float dy,int flags) • void al_draw_pixel(float x, float y, ALLEGRO_COLOR color) • void al_draw_rotated_bitmap(ALLEGRO_BITMAP *bitmap,float cx, float cy, float dx, float dy, float angle, int flags) • void al_draw_tinted_rotated_bitmap(ALLEGRO_BITMAP *bitmap,ALLEGRO_COLOR tint,float cx, float cy, float dx, float dy, float angle, int flags) • void al_draw_scaled_rotated_bitmap(ALLEGRO_BITMAP *bitmap,float cx, float cy, float dx, float dy, float xscale, float yscale,float angle, int flags) • void al_draw_tinted_scaled_rotated_bitmap(ALLEGRO_BITMAP *bitmap,ALLEGRO_COLOR tint,float cx, float cy, float dx, float dy, float xscale, float yscale,float angle, int flags) • void al_draw_tinted_scaled_rotated_bitmap_region(ALLEGRO_BITMAP *bitmap,float sx, float sy, float sw, float sh,ALLEGRO_COLOR tint,float cx, float cy, float dx, float dy, float xscale, float yscale,float angle, int flags) • void al_draw_scaled_bitmap(ALLEGRO_BITMAP *bitmap,float sx, float sy, float sw, float sh,float dx, float dy, float dw, float dh, int flags) • void al_draw_tinted_scaled_bitmap(ALLEGRO_BITMAP *bitmap,ALLEGRO_COLOR tint,float sx, float sy, float sw, float sh,float dx, float dy, float dw, float dh, int flags) • ALLEGRO_BITMAP *al_get_target_bitmap(void) 643
- 667. Ring Documentation, Release1.4.1 • void al_put_pixel(int x, int y, ALLEGRO_COLOR color) • void al_put_blended_pixel(int x, int y, ALLEGRO_COLOR color) • void al_set_target_bitmap(ALLEGRO_BITMAP *bitmap) • void al_set_target_backbuffer(ALLEGRO_DISPLAY *display) • ALLEGRO_DISPLAY *al_get_current_display(void) • void al_get_blender(int *op, int *src, int *dst) • void al_get_separate_blender(int *op, int *src, int *dst,int *alpha_op, int *alpha_src, int *alpha_dst) • void al_set_blender(int op, int src, int dst) • void al_set_separate_blender(int op, int src, int dst,int alpha_op, int alpha_src, int alpha_dst) • void al_get_clipping_rectangle(int *x, int *y, int *w, int *h) • void al_set_clipping_rectangle(int x, int y, int width, int height) • void al_reset_clipping_rectangle(void) • void al_convert_mask_to_alpha(ALLEGRO_BITMAP *bitmap, ALLEGRO_COLOR mask_color) • void al_hold_bitmap_drawing(bool hold) • bool al_is_bitmap_drawing_held(void) • ALLEGRO_BITMAP *al_load_bitmap_f(ALLEGRO_FILE *fp, const char *ident) • bool al_save_bitmap(const char *filename, ALLEGRO_BITMAP *bitmap) • bool al_save_bitmap_f(ALLEGRO_FILE *fp, const char *ident,ALLEGRO_BITMAP *bitmap) • bool al_install_joystick(void) • void al_uninstall_joystick(void) • bool al_is_joystick_installed(void) • bool al_reconfigure_joysticks(void) • int al_get_num_joysticks(void) • ALLEGRO_JOYSTICK * al_get_joystick(int num) • void al_release_joystick(ALLEGRO_JOYSTICK *joy) • bool al_get_joystick_active(ALLEGRO_JOYSTICK *joy) • const char *al_get_joystick_name(ALLEGRO_JOYSTICK *joy) • const char *al_get_joystick_stick_name(ALLEGRO_JOYSTICK *joy, int stick) • const char *al_get_joystick_axis_name(ALLEGRO_JOYSTICK *joy, int stick, int axis) • const char *al_get_joystick_button_name(ALLEGRO_JOYSTICK *joy, int button) • int al_get_joystick_stick_flags(ALLEGRO_JOYSTICK *joy, int stick) • int al_get_joystick_num_sticks(ALLEGRO_JOYSTICK *joy) • int al_get_joystick_num_axes(ALLEGRO_JOYSTICK *joy, int stick) • int al_get_joystick_num_buttons(ALLEGRO_JOYSTICK *joy) • void al_get_joystick_state(ALLEGRO_JOYSTICK *joy, ALLEGRO_JOYSTICK_STATE *ret_state) • ALLEGRO_EVENT_SOURCE *al_get_joystick_event_source(void) 644
- 668. Ring Documentation, Release1.4.1 • bool al_install_keyboard(void) • bool al_is_keyboard_installed(void) • void al_uninstall_keyboard(void) • void al_get_keyboard_state(ALLEGRO_KEYBOARD_STATE *ret_state) • bool al_key_down(const ALLEGRO_KEYBOARD_STATE *state, int keycode) • const char *al_keycode_to_name(int keycode) • bool al_set_keyboard_leds(int leds) • ALLEGRO_EVENT_SOURCE *al_get_keyboard_event_source(void) • void *al_malloc_with_context(size_t n,int line, const char *file, const char *func) • void al_free_with_context(void *ptr, int line, const char *file, const char *func) • void *al_realloc_with_context(void *ptr, size_t n,int line, const char *file, const char *func) • void *al_calloc_with_context(size_t count, size_t n,int line, const char *file, const char *func) • void al_set_memory_interface(ALLEGRO_MEMORY_INTERFACE *memory_interface) • int al_get_new_display_adapter(void) • void al_set_new_display_adapter(int adapter) • bool al_get_monitor_info(int adapter, ALLEGRO_MONITOR_INFO *info) • int al_get_num_video_adapters(void) • bool al_install_mouse(void) • bool al_is_mouse_installed(void) • void al_uninstall_mouse(void) • unsigned int al_get_mouse_num_axes(void) • unsigned int al_get_mouse_num_buttons(void) • void al_get_mouse_state(ALLEGRO_MOUSE_STATE *ret_state) • int al_get_mouse_state_axis(const ALLEGRO_MOUSE_STATE *state, int axis) • bool al_mouse_button_down(const ALLEGRO_MOUSE_STATE *state, int button) • bool al_set_mouse_xy(ALLEGRO_DISPLAY *display, int x, int y) • bool al_set_mouse_z(int z) • bool al_set_mouse_w(int w) • bool al_set_mouse_axis(int which, int value) • ALLEGRO_EVENT_SOURCE *al_get_mouse_event_source(void) • ALLEGRO_MOUSE_CURSOR *al_create_mouse_cursor(ALLEGRO_BITMAP *bmp,int x_focus, int y_focus) • void al_destroy_mouse_cursor(ALLEGRO_MOUSE_CURSOR *cursor) • bool al_set_mouse_cursor(ALLEGRO_DISPLAY *display, ALLEGRO_MOUSE_CURSOR *cursor) • bool al_set_system_mouse_cursor(ALLEGRO_DISPLAY *display,ALLEGRO_SYSTEM_MOUSE_CURSOR cursor_id) • bool al_get_mouse_cursor_position(int *ret_x, int *ret_y) 645
- 669. Ring Documentation, Release1.4.1 • bool al_hide_mouse_cursor(ALLEGRO_DISPLAY *display) • bool al_show_mouse_cursor(ALLEGRO_DISPLAY *display) • bool al_grab_mouse(ALLEGRO_DISPLAY *display) • bool al_ungrab_mouse(void) • ALLEGRO_PATH *al_create_path(const char *str) • ALLEGRO_PATH *al_create_path_for_directory(const char *str) • void al_destroy_path(ALLEGRO_PATH *path) • ALLEGRO_PATH *al_clone_path(const ALLEGRO_PATH *path) • bool al_join_paths(ALLEGRO_PATH *path, const ALLEGRO_PATH *tail) • bool al_rebase_path(const ALLEGRO_PATH *head, ALLEGRO_PATH *tail) • const char *al_get_path_drive(const ALLEGRO_PATH *path) • int al_get_path_num_components(const ALLEGRO_PATH *path) • const char *al_get_path_component(const ALLEGRO_PATH *path, int i) • const char *al_get_path_tail(const ALLEGRO_PATH *path) • const char *al_get_path_filename(const ALLEGRO_PATH *path) • const char *al_get_path_basename(const ALLEGRO_PATH *path) • const char *al_get_path_extension(const ALLEGRO_PATH *path) • void al_set_path_drive(ALLEGRO_PATH *path, const char *drive) • void al_append_path_component(ALLEGRO_PATH *path, const char *s) • void al_insert_path_component(ALLEGRO_PATH *path, int i, const char *s) • void al_replace_path_component(ALLEGRO_PATH *path, int i, const char *s) • void al_remove_path_component(ALLEGRO_PATH *path, int i) • void al_drop_path_tail(ALLEGRO_PATH *path) • void al_set_path_filename(ALLEGRO_PATH *path, const char *filename) • bool al_set_path_extension(ALLEGRO_PATH *path, char const *extension) • const char *al_path_cstr(const ALLEGRO_PATH *path, char delim) • bool al_make_path_canonical(ALLEGRO_PATH *path) • void al_restore_state(ALLEGRO_STATE const *state) • void al_store_state(ALLEGRO_STATE *state, int flags • int al_get_errno(void) • void al_set_errno(int errnum) • void al_uninstall_system(void) • bool al_is_system_installed(void) • uint32_t al_get_allegro_version(void) • ALLEGRO_PATH *al_get_standard_path(int id) • void al_set_exe_name(char const *path) 646
- 670. Ring Documentation, Release1.4.1 • void al_set_app_name(const char *app_name) • void al_set_org_name(const char *org_name) • const char *al_get_app_name(void) • const char *al_get_org_name(void) • ALLEGRO_CONFIG *al_get_system_config(void) • ALLEGRO_THREAD *al_create_thread(void) • void al_run_detached_thread(void) • void al_start_thread(ALLEGRO_THREAD *thread) • void al_join_thread(ALLEGRO_THREAD *thread, void **ret_value) • void al_set_thread_should_stop(ALLEGRO_THREAD *thread) • bool al_get_thread_should_stop(ALLEGRO_THREAD *thread) • void al_destroy_thread(ALLEGRO_THREAD *thread) • ALLEGRO_MUTEX *al_create_mutex(void) • ALLEGRO_MUTEX *al_create_mutex_recursive(void) • void al_lock_mutex(ALLEGRO_MUTEX *mutex) • void al_unlock_mutex(ALLEGRO_MUTEX *mutex) • void al_destroy_mutex(ALLEGRO_MUTEX *mutex) • ALLEGRO_COND *al_create_cond(void) • void al_destroy_cond(ALLEGRO_COND *cond) • void al_wait_cond(ALLEGRO_COND *cond, ALLEGRO_MUTEX *mutex) • int al_wait_cond_until(ALLEGRO_COND *cond, ALLEGRO_MUTEX *mutex,const ALLEGRO_TIMEOUT *timeout) • void al_broadcast_cond(ALLEGRO_COND *cond) • void al_signal_cond(ALLEGRO_COND *cond) • double al_get_time(void) • void al_init_timeout(ALLEGRO_TIMEOUT *timeout, double seconds) • void al_rest(double seconds) • ALLEGRO_TIMER *al_create_timer(double speed_secs) • void al_start_timer(ALLEGRO_TIMER *timer) • void al_stop_timer(ALLEGRO_TIMER *timer) • bool al_get_timer_started(const ALLEGRO_TIMER *timer) • void al_destroy_timer(ALLEGRO_TIMER *timer) • int64_t al_get_timer_count(const ALLEGRO_TIMER *timer) • void al_set_timer_count(ALLEGRO_TIMER *timer, int64_t new_count) • void al_add_timer_count(ALLEGRO_TIMER *timer, int64_t diff) • double al_get_timer_speed(const ALLEGRO_TIMER *timer) 647
- 671. Ring Documentation, Release1.4.1 • void al_set_timer_speed(ALLEGRO_TIMER *timer, double new_speed_secs) • ALLEGRO_EVENT_SOURCE *al_get_timer_event_source(ALLEGRO_TIMER *timer) • void al_copy_transform(ALLEGRO_TRANSFORM *dest, const ALLEGRO_TRANSFORM *src) • void al_use_transform(const ALLEGRO_TRANSFORM *trans) • const ALLEGRO_TRANSFORM *al_get_current_transform(void) • void al_invert_transform(ALLEGRO_TRANSFORM *trans) • int al_check_inverse(const ALLEGRO_TRANSFORM *trans, float tol) • void al_identity_transform(ALLEGRO_TRANSFORM *trans) • void al_build_transform(ALLEGRO_TRANSFORM *trans, float x, float y,float sx, float sy, float theta) • void al_translate_transform(ALLEGRO_TRANSFORM *trans, float x, float y) • void al_rotate_transform(ALLEGRO_TRANSFORM *trans, float theta) • void al_scale_transform(ALLEGRO_TRANSFORM *trans, float sx, float sy) • void al_transform_coordinates(const ALLEGRO_TRANSFORM *trans, float *x, float *y) • void al_compose_transform(ALLEGRO_TRANSFORM *trans, const ALLEGRO_TRANSFORM *other) • ALLEGRO_USTR *al_ustr_new(const char *s) • ALLEGRO_USTR *al_ustr_new_from_buffer(const char *s, size_t size) • void al_ustr_free(ALLEGRO_USTR *us) • const char *al_cstr(const ALLEGRO_USTR *us) • void al_ustr_to_buffer(const ALLEGRO_USTR *us, char *buffer, int size) • char *al_cstr_dup(const ALLEGRO_USTR *us) • ALLEGRO_USTR *al_ustr_dup(const ALLEGRO_USTR *us) • ALLEGRO_USTR *al_ustr_dup_substr(const ALLEGRO_USTR *us, int start_pos,int end_pos) • const ALLEGRO_USTR *al_ustr_empty_string(void) • const ALLEGRO_USTR *al_ref_cstr(ALLEGRO_USTR_INFO *info, const char *s) • const ALLEGRO_USTR *al_ref_buffer(ALLEGRO_USTR_INFO *info, const char *s, size_t size) • const ALLEGRO_USTR *al_ref_ustr(ALLEGRO_USTR_INFO *info, const ALLEGRO_USTR *us,int start_pos, int end_pos) • size_t al_ustr_size(const ALLEGRO_USTR *us) • size_t al_ustr_length(const ALLEGRO_USTR *us) • int al_ustr_offset(const ALLEGRO_USTR *us, int index) • bool al_ustr_next(const ALLEGRO_USTR *us, int *pos) • bool al_ustr_prev(const ALLEGRO_USTR *us, int *pos) • int32_t al_ustr_get(const ALLEGRO_USTR *ub, int pos) • int32_t al_ustr_get_next(const ALLEGRO_USTR *us, int *pos) • int32_t al_ustr_prev_get(const ALLEGRO_USTR *us, int *pos) • bool al_ustr_insert(ALLEGRO_USTR *us1, int pos, const ALLEGRO_USTR *us2) 648
- 672. Ring Documentation, Release1.4.1 • bool al_ustr_insert_cstr(ALLEGRO_USTR *us, int pos, const char *s) • size_t al_ustr_insert_chr(ALLEGRO_USTR *us, int pos, int32_t c) • bool al_ustr_append(ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2) • bool al_ustr_append_cstr(ALLEGRO_USTR *us, const char *s) • size_t al_ustr_append_chr(ALLEGRO_USTR *us, int32_t c) • bool al_ustr_remove_chr(ALLEGRO_USTR *us, int pos) • bool al_ustr_remove_range(ALLEGRO_USTR *us, int start_pos, int end_pos) • bool al_ustr_truncate(ALLEGRO_USTR *us, int start_pos) • bool al_ustr_ltrim_ws(ALLEGRO_USTR *us) • bool al_ustr_rtrim_ws(ALLEGRO_USTR *us) • bool al_ustr_trim_ws(ALLEGRO_USTR *us) • bool al_ustr_assign(ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2) • bool al_ustr_assign_substr(ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2,int start_pos, int end_pos) • bool al_ustr_assign_cstr(ALLEGRO_USTR *us1, const char *s) • size_t al_ustr_set_chr(ALLEGRO_USTR *us, int start_pos, int32_t c) • bool al_ustr_replace_range(ALLEGRO_USTR *us1, int start_pos1, int end_pos1,const ALLEGRO_USTR *us2) • int al_ustr_find_chr(const ALLEGRO_USTR *us, int start_pos, int32_t c) • int al_ustr_rfind_chr(const ALLEGRO_USTR *us, int end_pos, int32_t c) • int al_ustr_find_set(const ALLEGRO_USTR *us, int start_pos,const ALLEGRO_USTR *accept) • int al_ustr_find_set_cstr(const ALLEGRO_USTR *us, int start_pos,const char *accept) • int al_ustr_find_cset(const ALLEGRO_USTR *us, int start_pos,const ALLEGRO_USTR *reject) • int al_ustr_find_cset_cstr(const ALLEGRO_USTR *us, int start_pos,const char *reject) • int al_ustr_find_str(const ALLEGRO_USTR *haystack, int start_pos,const ALLEGRO_USTR *needle) • int al_ustr_find_cstr(const ALLEGRO_USTR *haystack, int start_pos,const char *needle) • int al_ustr_rfind_str(const ALLEGRO_USTR *haystack, int end_pos,const ALLEGRO_USTR *needle) • int al_ustr_rfind_cstr(const ALLEGRO_USTR *haystack, int end_pos,const char *needle) • bool al_ustr_find_replace(ALLEGRO_USTR *us, int start_pos,const ALLEGRO_USTR *find, const ALLE- GRO_USTR *replace) • bool al_ustr_find_replace_cstr(ALLEGRO_USTR *us, int start_pos,const char *find, const char *replace) • int al_ustr_compare(const ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2) • int al_ustr_ncompare(const ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2, int n) • bool al_ustr_equal(const ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2) • bool al_ustr_has_prefix(const ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2) • bool al_ustr_has_prefix_cstr(const ALLEGRO_USTR *us1, const char *s2) • bool al_ustr_has_suffix(const ALLEGRO_USTR *us1, const ALLEGRO_USTR *us2) • bool al_ustr_has_suffix_cstr(const ALLEGRO_USTR *us1, const char *s2) 649
- 673. Ring Documentation, Release1.4.1 • ALLEGRO_USTR *al_ustr_new_from_utf16(uint16_t const *s) • size_t al_ustr_size_utf16(const ALLEGRO_USTR *us) • size_t al_ustr_encode_utf16(const ALLEGRO_USTR *us, uint16_t *s,size_t n) • size_t al_utf8_width(int c) • size_t al_utf8_encode(char s[], int32_t c) • size_t al_utf16_width(int c) • LPDIRECT3DDEVICE9 al_get_d3d_device(ALLEGRO_DISPLAY *display) • LPDIRECT3DTEXTURE9 al_get_d3d_system_texture(ALLEGRO_BITMAP *bitmap) • LPDIRECT3DTEXTURE9 al_get_d3d_video_texture(ALLEGRO_BITMAP *bitmap) • bool al_have_d3d_non_pow2_texture_support(void) • bool al_have_d3d_non_square_texture_support(void) • void al_get_d3d_texture_position(ALLEGRO_BITMAP *bitmap, int *u, int *v) • bool al_is_d3d_device_lost(ALLEGRO_DISPLAY *display) • ALLEGRO_OGL_EXT_LIST *al_get_opengl_extension_list(void) • void *al_get_opengl_proc_address(const char *name) • GLuint al_get_opengl_texture(ALLEGRO_BITMAP *bitmap) • void al_get_opengl_texture_size(ALLEGRO_BITMAP *bitmap, int *w, int *h) • void al_get_opengl_texture_position(ALLEGRO_BITMAP *bitmap, int *u, int *v) • GLuint al_get_opengl_fbo(ALLEGRO_BITMAP *bitmap) • void al_remove_opengl_fbo(ALLEGRO_BITMAP *bitmap) • bool al_have_opengl_extension(const char *extension); • uint32_t al_get_opengl_version(void) • int al_get_opengl_variant(void) • void al_set_current_opengl_context(ALLEGRO_DISPLAY *display) • bool al_install_audio(void) • void al_uninstall_audio(void) • bool al_is_audio_installed(void) • bool al_reserve_samples(int reserve_samples) • uint32_t al_get_allegro_audio_version(void) • size_t al_get_audio_depth_size(ALLEGRO_AUDIO_DEPTH depth) • size_t al_get_channel_count(ALLEGRO_CHANNEL_CONF conf) • ALLEGRO_VOICE *al_create_voice(unsigned int freq,ALLEGRO_AUDIO_DEPTH depth, ALLE- GRO_CHANNEL_CONF chan_conf) • void al_destroy_voice(ALLEGRO_VOICE *voice) • void al_detach_voice(ALLEGRO_VOICE *voice) • bool al_attach_audio_stream_to_voice(ALLEGRO_AUDIO_STREAM *stream,ALLEGRO_VOICE *voice) 650
- 674. Ring Documentation, Release1.4.1 • bool al_attach_mixer_to_voice(ALLEGRO_MIXER *mixer, ALLEGRO_VOICE *voice) • bool al_attach_sample_instance_to_voice(ALLEGRO_SAMPLE_INSTANCE *spl,ALLEGRO_VOICE *voice) • unsigned int al_get_voice_frequency(const ALLEGRO_VOICE *voice) • ALLEGRO_CHANNEL_CONF al_get_voice_channels(const ALLEGRO_VOICE *voice) • ALLEGRO_AUDIO_DEPTH al_get_voice_depth(const ALLEGRO_VOICE *voice) • bool al_get_voice_playing(const ALLEGRO_VOICE *voice) • bool al_set_voice_playing(ALLEGRO_VOICE *voice, bool val) • unsigned int al_get_voice_position(const ALLEGRO_VOICE *voice) • bool al_set_voice_position(ALLEGRO_VOICE *voice, unsigned int val) • ALLEGRO_SAMPLE *al_create_sample(void *buf, unsigned int samples,unsigned int freq, ALLE- GRO_AUDIO_DEPTH depth,ALLEGRO_CHANNEL_CONF chan_conf, bool free_buf) • void al_destroy_sample(ALLEGRO_SAMPLE *spl) • bool al_play_sample(ALLEGRO_SAMPLE *spl, float gain, float pan, float speed,int loop, ALLE- GRO_SAMPLE_ID *ret_id) • void al_stop_sample(ALLEGRO_SAMPLE_ID *spl_id) • void al_stop_samples(void) • ALLEGRO_CHANNEL_CONF al_get_sample_channels(const ALLEGRO_SAMPLE *spl) • ALLEGRO_AUDIO_DEPTH al_get_sample_depth(const ALLEGRO_SAMPLE *spl) • unsigned int al_get_sample_frequency(const ALLEGRO_SAMPLE *spl) • unsigned int al_get_sample_length(const ALLEGRO_SAMPLE *spl) • void *al_get_sample_data(const ALLEGRO_SAMPLE *spl) • ALLEGRO_SAMPLE_INSTANCE *al_create_sample_instance(ALLEGRO_SAMPLE *sample_data) • void al_destroy_sample_instance(ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_play_sample_instance(ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_stop_sample_instance(ALLEGRO_SAMPLE_INSTANCE *spl) • ALLEGRO_CHANNEL_CONF al_get_sample_instance_channels(const ALLEGRO_SAMPLE_INSTANCE *spl) • ALLEGRO_AUDIO_DEPTH al_get_sample_instance_depth(const ALLEGRO_SAMPLE_INSTANCE *spl) • unsigned int al_get_sample_instance_frequency(const ALLEGRO_SAMPLE_INSTANCE *spl) • unsigned int al_get_sample_instance_length(const ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_set_sample_instance_length(ALLEGRO_SAMPLE_INSTANCE *spl,unsigned int val) • unsigned int al_get_sample_instance_position(const ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_set_sample_instance_position(ALLEGRO_SAMPLE_INSTANCE *spl,unsigned int val) • float al_get_sample_instance_speed(const ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_set_sample_instance_speed(ALLEGRO_SAMPLE_INSTANCE *spl, float val) • float al_get_sample_instance_gain(const ALLEGRO_SAMPLE_INSTANCE *spl) 651
- 675. Ring Documentation, Release1.4.1 • bool al_set_sample_instance_gain(ALLEGRO_SAMPLE_INSTANCE *spl, float val) • float al_get_sample_instance_pan(const ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_set_sample_instance_pan(ALLEGRO_SAMPLE_INSTANCE *spl, float val) • float al_get_sample_instance_time(const ALLEGRO_SAMPLE_INSTANCE *spl) • ALLEGRO_PLAYMODE al_get_sample_instance_playmode(const ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_set_sample_instance_playmode(ALLEGRO_SAMPLE_INSTANCE *spl,ALLEGRO_PLAYMODE val) • bool al_get_sample_instance_playing(const ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_set_sample_instance_playing(ALLEGRO_SAMPLE_INSTANCE *spl, bool val) • bool al_get_sample_instance_attached(const ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_detach_sample_instance(ALLEGRO_SAMPLE_INSTANCE *spl) • ALLEGRO_SAMPLE *al_get_sample(ALLEGRO_SAMPLE_INSTANCE *spl) • bool al_set_sample(ALLEGRO_SAMPLE_INSTANCE *spl, ALLEGRO_SAMPLE *data) • ALLEGRO_MIXER *al_create_mixer(unsigned int freq,ALLEGRO_AUDIO_DEPTH depth, ALLE- GRO_CHANNEL_CONF chan_conf) • void al_destroy_mixer(ALLEGRO_MIXER *mixer) • ALLEGRO_MIXER *al_get_default_mixer(void) • bool al_set_default_mixer(ALLEGRO_MIXER *mixer) • bool al_restore_default_mixer(void) • bool al_attach_mixer_to_mixer(ALLEGRO_MIXER *stream, ALLEGRO_MIXER *mixer) • bool al_attach_sample_instance_to_mixer(ALLEGRO_SAMPLE_INSTANCE *spl,ALLEGRO_MIXER *mixer) • bool al_attach_audio_stream_to_mixer(ALLEGRO_AUDIO_STREAM *stream, ALLEGRO_MIXER *mixer) • unsigned int al_get_mixer_frequency(const ALLEGRO_MIXER *mixer) • bool al_set_mixer_frequency(ALLEGRO_MIXER *mixer, unsigned int val) • ALLEGRO_CHANNEL_CONF al_get_mixer_channels(const ALLEGRO_MIXER *mixer) • ALLEGRO_AUDIO_DEPTH al_get_mixer_depth(const ALLEGRO_MIXER *mixer) • float al_get_mixer_gain(const ALLEGRO_MIXER *mixer) • bool al_set_mixer_gain(ALLEGRO_MIXER *mixer, float new_gain) • ALLEGRO_MIXER_QUALITY al_get_mixer_quality(const ALLEGRO_MIXER *mixer) • bool al_set_mixer_quality(ALLEGRO_MIXER *mixer, ALLEGRO_MIXER_QUALITY new_quality) • bool al_get_mixer_playing(const ALLEGRO_MIXER *mixer) • bool al_set_mixer_playing(ALLEGRO_MIXER *mixer, bool val) • bool al_get_mixer_attached(const ALLEGRO_MIXER *mixer) • bool al_detach_mixer(ALLEGRO_MIXER *mixer) • void al_destroy_audio_stream(ALLEGRO_AUDIO_STREAM *stream) 652
- 676. Ring Documentation, Release1.4.1 • ALLEGRO_EVENT_SOURCE *al_get_audio_stream_event_source(ALLEGRO_AUDIO_STREAM *stream) • void al_drain_audio_stream(ALLEGRO_AUDIO_STREAM *stream) • bool al_rewind_audio_stream(ALLEGRO_AUDIO_STREAM *stream) • unsigned int al_get_audio_stream_frequency(const ALLEGRO_AUDIO_STREAM *stream) • ALLEGRO_CHANNEL_CONF al_get_audio_stream_channels(const ALLEGRO_AUDIO_STREAM *stream) • ALLEGRO_AUDIO_DEPTH al_get_audio_stream_depth(const ALLEGRO_AUDIO_STREAM *stream) • unsigned int al_get_audio_stream_length(const ALLEGRO_AUDIO_STREAM *stream) • float al_get_audio_stream_speed(const ALLEGRO_AUDIO_STREAM *stream) • bool al_set_audio_stream_speed(ALLEGRO_AUDIO_STREAM *stream, float val) • float al_get_audio_stream_gain(const ALLEGRO_AUDIO_STREAM *stream) • bool al_set_audio_stream_gain(ALLEGRO_AUDIO_STREAM *stream, float val) • float al_get_audio_stream_pan(const ALLEGRO_AUDIO_STREAM *stream) • bool al_set_audio_stream_pan(ALLEGRO_AUDIO_STREAM *stream, float val) • bool al_get_audio_stream_playing(const ALLEGRO_AUDIO_STREAM *stream) • bool al_set_audio_stream_playing(ALLEGRO_AUDIO_STREAM *stream, bool val) • ALLEGRO_PLAYMODE al_get_audio_stream_playmode(const ALLEGRO_AUDIO_STREAM *stream) • bool al_set_audio_stream_playmode(ALLEGRO_AUDIO_STREAM *stream,ALLEGRO_PLAYMODE val) • bool al_get_audio_stream_attached(const ALLEGRO_AUDIO_STREAM *stream) • bool al_detach_audio_stream(ALLEGRO_AUDIO_STREAM *stream) • void *al_get_audio_stream_fragment(const ALLEGRO_AUDIO_STREAM *stream) • bool al_set_audio_stream_fragment(ALLEGRO_AUDIO_STREAM *stream, void *val) • unsigned int al_get_audio_stream_fragments(const ALLEGRO_AUDIO_STREAM *stream) • unsigned int al_get_available_audio_stream_fragments(const ALLEGRO_AUDIO_STREAM *stream) • bool al_seek_audio_stream_secs(ALLEGRO_AUDIO_STREAM *stream, double time) • double al_get_audio_stream_position_secs(ALLEGRO_AUDIO_STREAM *stream) • double al_get_audio_stream_length_secs(ALLEGRO_AUDIO_STREAM *stream) • bool al_set_audio_stream_loop_secs(ALLEGRO_AUDIO_STREAM *stream,double start, double end) • ALLEGRO_SAMPLE *al_load_sample(const char *filename) • ALLEGRO_SAMPLE al_load_sample_f(ALLEGRO_FILE fp, const char *ident) • ALLEGRO_AUDIO_STREAM *al_load_audio_stream(const char *filename,size_t buffer_count, unsigned int samples) • ALLEGRO_AUDIO_STREAM al_load_audio_stream_f(ALLEGRO_FILE fp, const char *ident,size_t buffer_count, unsigned int samples) • bool al_save_sample(const char *filename, ALLEGRO_SAMPLE *spl) • bool al_save_sample_f(ALLEGRO_FILE *fp, const char *ident, ALLEGRO_SAMPLE *spl) 653
- 677. Ring Documentation, Release1.4.1 • bool al_init_acodec_addon(void) • uint32_t al_get_allegro_acodec_version(void) • ALLEGRO_COLOR al_color_cmyk(float c, float m, float y, float k) • void al_color_cmyk_to_rgb(float cyan, float magenta, float yellow,float key, float *red, float *green, float *blue) • ALLEGRO_COLOR al_color_hsl(float h, float s, float l) • void al_color_hsl_to_rgb(float hue, float saturation, float lightness,float *red, float *green, float *blue) • ALLEGRO_COLOR al_color_hsv(float h, float s, float v) • void al_color_hsv_to_rgb(float hue, float saturation, float value,float *red, float *green, float *blue) • ALLEGRO_COLOR al_color_html(char const *string) • void al_color_html_to_rgb(char const *string,float *red, float *green, float *blue) • void al_color_rgb_to_html(float red, float green, float blue,char *string) • ALLEGRO_COLOR al_color_name(char const *name) • bool al_color_name_to_rgb(char const *name, float *r, float *g, float *b) • void al_color_rgb_to_cmyk(float red, float green, float blue,float *cyan, float *magenta, float *yellow, float *key) • void al_color_rgb_to_hsl(float red, float green, float blue,float *hue, float *saturation, float *lightness) • void al_color_rgb_to_hsv(float red, float green, float blue,float *hue, float *saturation, float *value) • char const *al_color_rgb_to_name(float r, float g, float b) • void al_color_rgb_to_yuv(float red, float green, float blue,float *y, float *u, float *v) • ALLEGRO_COLOR al_color_yuv(float y, float u, float v) • void al_color_yuv_to_rgb(float y, float u, float v,float *red, float *green, float *blue) • uint32_t al_get_allegro_color_version(void) • void al_init_font_addon(void) • void al_shutdown_font_addon(void) • ALLEGRO_FONT *al_load_font(char const *filename, int size, int flags) • void al_destroy_font(ALLEGRO_FONT *f) • int al_get_font_ascent(const ALLEGRO_FONT *f) • int al_get_font_descent(const ALLEGRO_FONT *f) • int al_get_text_width(const ALLEGRO_FONT *f, const char *str) • int al_get_ustr_width(const ALLEGRO_FONT *f, ALLEGRO_USTR const *ustr) • void al_draw_text(const ALLEGRO_FONT *font,ALLEGRO_COLOR color, float x, float y, int flags,char const *text) • void al_draw_ustr(const ALLEGRO_FONT *font,ALLEGRO_COLOR color, float x, float y, int flags,const ALLEGRO_USTR *ustr) • void al_draw_justified_text(const ALLEGRO_FONT *font,ALLEGRO_COLOR color, float x1, float x2,float y, float diff, int flags, const char *text) • void al_draw_justified_ustr(const ALLEGRO_FONT *font,ALLEGRO_COLOR color, float x1, float x2,float y, float diff, int flags, const ALLEGRO_USTR *ustr) 654
- 678. Ring Documentation, Release1.4.1 • void al_get_text_dimensions(const ALLEGRO_FONT *f,char const *text,int *bbx, int *bby, int *bbw, int *bbh) • void al_get_ustr_dimensions(const ALLEGRO_FONT *f,ALLEGRO_USTR const *ustr,int *bbx, int *bby, int *bbw, int *bbh) • uint32_t al_get_allegro_font_version(void) • ALLEGRO_FONT *al_grab_font_from_bitmap(ALLEGRO_BITMAP *bmp,int ranges_n, const int ranges[]) • ALLEGRO_FONT *al_load_bitmap_font(const char *fname) • ALLEGRO_FONT *al_create_builtin_font(void) • bool al_init_ttf_addon(void) • void al_shutdown_ttf_addon(void) • ALLEGRO_FONT *al_load_ttf_font(char const *filename, int size, int flags) • ALLEGRO_FONT *al_load_ttf_font_f(ALLEGRO_FILE *file,char const *filename, int size, int flags) • ALLEGRO_FONT *al_load_ttf_font_stretch(char const *filename, int w, int h,int flags) • ALLEGRO_FONT *al_load_ttf_font_stretch_f(ALLEGRO_FILE *file,char const *filename, int w, int h, int flags) • uint32_t al_get_allegro_ttf_version(void) • bool al_init_image_addon(void) • void al_shutdown_image_addon(void) • uint32_t al_get_allegro_image_version(void) • ALLEGRO_FILE *al_open_memfile(void *mem, int64_t size, const char *mode) • uint32_t al_get_allegro_memfile_version(void) • bool al_init_native_dialog_addon(void) • void al_shutdown_native_dialog_addon(void) • ALLEGRO_FILECHOOSER *al_create_native_file_dialog(char const *initial_path,char const *title,char const *patterns,int mode) • bool al_show_native_file_dialog(ALLEGRO_DISPLAY *display,ALLEGRO_FILECHOOSER *dialog) • int al_get_native_file_dialog_count(const ALLEGRO_FILECHOOSER *dialog) • const char *al_get_native_file_dialog_path(const ALLEGRO_FILECHOOSER *dialog, size_t i) • void al_destroy_native_file_dialog(ALLEGRO_FILECHOOSER *dialog) • int al_show_native_message_box(ALLEGRO_DISPLAY *display,char const *title, char const *heading, char const *text,char const *buttons, int flags) • ALLEGRO_TEXTLOG *al_open_native_text_log(char const *title, int flags) • void al_close_native_text_log(ALLEGRO_TEXTLOG *textlog) • uint32_t al_get_allegro_native_dialog_version(void) • void al_set_physfs_file_interface(void) • uint32_t al_get_allegro_physfs_version(void) • uint32_t al_get_allegro_primitives_version(void) • bool al_init_primitives_addon(void) 655
- 679. Ring Documentation, Release1.4.1 • void al_shutdown_primitives_addon(void) • void al_draw_line(float x1, float y1, float x2, float y2,ALLEGRO_COLOR color, float thickness) • void al_draw_triangle(float x1, float y1, float x2, float y2,float x3, float y3, ALLEGRO_COLOR color, float thickness) • void al_draw_filled_triangle(float x1, float y1, float x2, float y2,float x3, float y3, ALLEGRO_COLOR color) • void al_draw_rectangle(float x1, float y1, float x2, float y2,ALLEGRO_COLOR color, float thickness) • void al_draw_filled_rectangle(float x1, float y1, float x2, float y2,ALLEGRO_COLOR color) • void al_draw_rounded_rectangle(float x1, float y1, float x2, float y2,float rx, float ry, ALLEGRO_COLOR color, float thickness) • void al_draw_filled_rounded_rectangle(float x1, float y1, float x2, float y2,float rx, float ry, ALLEGRO_COLOR color) • void al_calculate_arc(float* dest, int stride, float cx, float cy,float rx, float ry, float start_theta, float delta_theta, float thickness,int num_points) • void al_draw_pieslice(float cx, float cy, float r, float start_theta,float delta_theta, ALLEGRO_COLOR color, float thickness) • void al_draw_filled_pieslice(float cx, float cy, float r, float start_theta,float delta_theta, ALLEGRO_COLOR color) • void al_draw_ellipse(float cx, float cy, float rx, float ry,ALLEGRO_COLOR color, float thickness) • void al_draw_filled_ellipse(float cx, float cy, float rx, float ry,ALLEGRO_COLOR color) • void al_draw_circle(float cx, float cy, float r, ALLEGRO_COLOR color,float thickness) • void al_draw_filled_circle(float cx, float cy, float r, ALLEGRO_COLOR color) • void al_draw_arc(float cx, float cy, float r, float start_theta,float delta_theta, ALLEGRO_COLOR color, float thickness) • void al_draw_elliptical_arc(float cx, float cy, float rx, float ry, float start_theta,float delta_theta, ALLE- GRO_COLOR color, float thickness) • void al_draw_ribbon(const float *points, int points_stride, ALLEGRO_COLOR color,float thickness, int num_segments) • int al_draw_prim(const void* vtxs, const ALLEGRO_VERTEX_DECL* decl,ALLEGRO_BITMAP* texture, int start, int end, int type) • int al_draw_indexed_prim(const void* vtxs, const ALLEGRO_VERTEX_DECL* decl,ALLEGRO_BITMAP* texture, const int* indices, int num_vtx, int type) • ALLEGRO_VERTEX_DECL* al_create_vertex_decl(const ALLEGRO_VERTEX_ELEMENT* elements, int stride) • void al_destroy_vertex_decl(ALLEGRO_VERTEX_DECL* decl) 656
- 680. CHAPTER SIXTYNINE RINGLIBSDL FUNCTIONS REFERENCE •void SDL_RenderCopy2(SDL_Renderer *,SDL_Texture *) • void SDL_Delay(int) • void SDL_Init(int) • int SDL_InitSubSystem(Uint32 flags) • void SDL_Quit(void) • void SDL_QuitSubSystem(Uint32 flags) • void SDL_SetMainReady(void) • Uint32 SDL_WasInit(Uint32 flags) • SDL_bool SDL_SetHint(const char *name,const char *value) • SDL_bool SDL_SetHintWithPriority(const char *name,const char *value,SDL_HintPriority priority) • void SDL_ClearError(void) • const char *SDL_GetError(void) • SDL_LogPriority SDL_LogGetPriority(int category) • void SDL_LogResetPriorities(void) • void SDL_LogSetAllPriority(SDL_LogPriority priority) • SDL_AssertionHandler SDL_GetDefaultAssertionHandler(void) • void SDL_ResetAssertionReport(void) • void SDL_SetAssertionHandler(SDL_AssertionHandler handler,void *userdata) • void SDL_TriggerBreakpoint(void) • void SDL_assert(int) • void SDL_assert_paranoid(int) • void SDL_assert_release(int) • const char * SDL_GetRevision(void) • int SDL_GetRevisionNumber(void) • void SDL_GetVersion(SDL_version *ver) • SDL_Window *SDL_CreateWindow(const char * title,int x, int y,int w,int h,Uint32 flags) • void SDL_DestroyWindow(SDL_Window *window) 657
- 681. Ring Documentation, Release1.4.1 • void SDL_DisableScreenSaver(void) • void SDL_EnableScreenSaver(void) • SDL_GLContext SDL_GL_CreateContext(SDL_Window *window) • void SDL_GL_DeleteContext(SDL_GLContext context) • SDL_bool SDL_GL_ExtensionSupported(const char *extension) • int SDL_GL_GetAttribute(SDL_GLattr attr,int *value) • SDL_GLContext SDL_GL_GetCurrentContext(void) • SDL_Window *SDL_GL_GetCurrentWindow(void) • void SDL_GL_GetDrawableSize(SDL_Window *window,int *w,int *h) • void *SDL_GL_GetProcAddress(const char *proc) • int SDL_GL_GetSwapInterval(void) • int SDL_GL_LoadLibrary(const char *path) • int SDL_GL_MakeCurrent(SDL_Window *window,SDL_GLContext context) • void SDL_GL_ResetAttributes(void) • int SDL_GL_SetAttribute(SDL_GLattr attr,int value) • int SDL_GL_SetSwapInterval(int interval) • void SDL_GL_SwapWindow(SDL_Window *window) • void SDL_GL_UnloadLibrary(void) • SDL_DisplayMode *SDL_GetClosestDisplayMode(int displayIndex,SDL_DisplayMode *mode,SDL_DisplayMode *closest) • int SDL_GetCurrentDisplayMode(int displayIndex,SDL_DisplayMode *mode) • const char *SDL_GetCurrentVideoDriver(void) • int SDL_GetDesktopDisplayMode(int displayIndex,SDL_DisplayMode *mode) • int SDL_GetDisplayBounds(int displayIndex,SDL_Rect *rect) • int SDL_GetNumVideoDisplays(void) • int SDL_GetNumVideoDrivers(void) • const char * SDL_GetVideoDriver(int index) • void *SDL_GetWindowData(SDL_Window *window,const char *name) • int SDL_GetWindowDisplayIndex(SDL_Window *window) • int SDL_GetWindowDisplayMode(SDL_Window *window,SDL_DisplayMode *mode) • Uint32 SDL_GetWindowFlags(SDL_Window *window) • SDL_Window *SDL_GetWindowFromID(Uint32 id) • int SDL_GetWindowGammaRamp(SDL_Window *window,Uint16 *red,Uint16 *green,Uint16 *blue) • SDL_bool SDL_GetWindowGrab(SDL_Window *window) • Uint32 SDL_GetWindowID(SDL_Window* window) • void SDL_GetWindowMaximumSize(SDL_Window *window,int *w,int *h) 658
- 682. Ring Documentation, Release1.4.1 • void SDL_GetWindowMinimumSize(SDL_Window *window,int *w,int *h) • void SDL_GetWindowPosition(SDL_Window *window,int *x,int *y) • void SDL_GetWindowSize(SDL_Window *window,int *w,int *h) • SDL_Surface *SDL_GetWindowSurface(SDL_Window *window) • const char *SDL_GetWindowTitle(SDL_Window *window) • SDL_bool SDL_IsScreenSaverEnabled(void) • void SDL_MaximizeWindow(SDL_Window *window) • void SDL_MinimizeWindow(SDL_Window *window) • void SDL_RaiseWindow(SDL_Window *window) • void SDL_RestoreWindow(SDL_Window *window) • void SDL_SetWindowBordered(SDL_Window *window,SDL_bool bordered) • int SDL_SetWindowBrightness(SDL_Window *window,float brightness) • void *SDL_SetWindowData(SDL_Window *window,const char *name,void *userdata) • int SDL_SetWindowDisplayMode(SDL_Window *window,const SDL_DisplayMode *mode) • int SDL_SetWindowFullscreen(SDL_Window *window,Uint32 flags) • int SDL_SetWindowGammaRamp(SDL_Window window,const Uint16 *red,const Uint16 *green,const Uint16 blue) • void SDL_SetWindowGrab(SDL_Window *window,SDL_bool grabbed) • void SDL_SetWindowMinimumSize(SDL_Window* window,int min_w,int min_h) • void SDL_SetWindowSize(SDL_Window *window,int w,int h) • void SDL_SetWindowTitle(SDL_Window *window,const char *title) • int SDL_ShowMessageBox(const SDL_MessageBoxData *messageboxdata,int *buttonid) • int SDL_ShowSimpleMessageBox(Uint32 flags,const char *title,const char *message,SDL_Window *window) • void SDL_ShowWindow(SDL_Window *window) • int SDL_UpdateWindowSurface(SDL_Window *window) • int SDL_UpdateWindowSurfaceRects(SDL_Window *window,const SDL_Rect *rects,int numrects) • int SDL_VideoInit(const char *driver_name) • void SDL_VideoQuit(void) • SDL_Renderer *SDL_CreateRenderer(SDL_Window *window,int index,Uint32 flags) • SDL_Renderer *SDL_CreateSoftwareRenderer(SDL_Surface *surface) • SDL_Texture *SDL_CreateTexture(SDL_Renderer *renderer,Uint32 format,int access,int w,int h) • SDL_Texture *SDL_CreateTextureFromSurface(SDL_Renderer *renderer,SDL_Surface *surface) • void SDL_DestroyTexture(SDL_Texture *texture) • int SDL_GL_BindTexture(SDL_Texture *texture,float *texw,float *texh) • int SDL_GL_UnbindTexture(SDL_Texture *texture) • int SDL_GetNumRenderDrivers(void) 659
- 683. Ring Documentation, Release1.4.1 • int SDL_GetRenderDrawBlendMode(SDL_Renderer *renderer,SDL_BlendMode *blendMode) • int SDL_GetRenderDrawColor(SDL_Renderer *renderer,Uint8 *r,Uint8 *g,Uint8 *b,Uint8 *a) • int SDL_GetRenderDriverInfo(int index,SDL_RendererInfo *info) • SDL_Texture *SDL_GetRenderTarget(SDL_Renderer *renderer) • SDL_Renderer *SDL_GetRenderer(SDL_Window *window) • int SDL_GetRendererInfo(SDL_Renderer *renderer,SDL_RendererInfo *info) • int SDL_GetRendererOutputSize(SDL_Renderer *renderer,int *w,int *h) • int SDL_GetTextureAlphaMod(SDL_Texture *texture,Uint8 *alpha) • int SDL_GetTextureBlendMode(SDL_Texture *texture,SDL_BlendMode *blendMode) • int SDL_GetTextureColorMod(SDL_Texture *texture,Uint8 *r,Uint8 *g,Uint8 *b) • int SDL_LockTexture(SDL_Texture *texture,const SDL_Rect *rect,void **pixels,int *pitch) • int SDL_QueryTexture(SDL_Texture *texture,int *format,int *access,int *w,int *h) • int SDL_RenderClear(SDL_Renderer *renderer) • int SDL_RenderCopy(SDL_Renderer *renderer,SDL_Texture *texture,const SDL_Rect *srcrect,const SDL_Rect *dstrect) • int SDL_RenderCopyEx(SDL_Renderer *renderer,SDL_Texture *texture,const SDL_Rect *srcrect,const SDL_Rect *dstrect,const double angle,const SDL_Point *center,const SDL_RendererFlip flip) • int SDL_RenderDrawLine(SDL_Renderer *renderer,int x1,int y1,int x2,int y2) • int SDL_RenderDrawLines(SDL_Renderer *renderer,const SDL_Point *points,int count) • int SDL_RenderDrawPoint(SDL_Renderer *renderer,int x, int y) • int SDL_RenderDrawPoints(SDL_Renderer *renderer,const SDL_Point *points,int count) • int SDL_RenderDrawRect(SDL_Renderer *renderer,const SDL_Rect *rect) • int SDL_RenderDrawRects(SDL_Renderer *renderer,const SDL_Rect *rects,int count) • int SDL_RenderFillRect(SDL_Renderer *renderer,const SDL_Rect *rect) • int SDL_RenderFillRects(SDL_Renderer renderer,const SDL_Rect rects,int count) • void SDL_RenderGetClipRect(SDL_Renderer *renderer,SDL_Rect *rect) • void SDL_RenderGetScale(SDL_Renderer *renderer,float *scaleX,float *scaleY) • void SDL_RenderGetViewport(SDL_Renderer *renderer,SDL_Rect *rect) • int SDL_RenderReadPixels(SDL_Renderer *renderer,const SDL_Rect *rect,Uint32 format,void *pixels,int pitch) • int SDL_RenderSetClipRect(SDL_Renderer *renderer,const SDL_Rect *rect) • int SDL_RenderSetScale(SDL_Renderer *renderer,float scaleX,float scaleY) • int SDL_RenderSetViewport(SDL_Renderer *renderer,const SDL_Rect *rect) • SDL_bool SDL_RenderTargetSupported(SDL_Renderer *renderer) • int SDL_SetRenderDrawBlendMode(SDL_Renderer *renderer,SDL_BlendMode blendMode) • int SDL_SetRenderDrawColor(SDL_Renderer *renderer,Uint8 r,Uint8 g,Uint8 b,Uint8 a) • int SDL_SetRenderTarget(SDL_Renderer *renderer,SDL_Texture *texture) 660
- 684. Ring Documentation, Release1.4.1 • int SDL_SetTextureAlphaMod(SDL_Texture *texture,Uint8 alpha) • int SDL_SetTextureBlendMode(SDL_Texture *texture,SDL_BlendMode blendMode) • int SDL_SetTextureColorMod(SDL_Texture *texture,Uint8 r,Uint8 g,Uint8 b) • void SDL_UnlockTexture(SDL_Texture *texture) • int SDL_UpdateTexture(SDL_Texture *texture,const SDL_Rect *rect,const void*pixels,int pitch) • int SDL_UpdateYUVTexture(SDL_Texture *texture,const SDL_Rect *rect,const Uint8 *Yplane,int Yp- itch,const Uint8 *Uplane,int Upitch,const Uint8 *Vplane,int Vpitch) • SDL_PixelFormat *SDL_AllocFormat(Uint32 pixel_format) • SDL_Palette *SDL_AllocPalette(int ncolors) • void SDL_CalculateGammaRamp(float gamma,Uint16 *ramp) • void SDL_FreeFormat(SDL_PixelFormat *format) • void SDL_FreePalette(SDL_Palette *palette) • const char *SDL_GetPixelFormatName(Uint32 format) • void SDL_GetRGB(Uint32 pixel,const SDL_PixelFormat* format,Uint8 *r,Uint8 *g,Uint8 *b) • void SDL_GetRGBA(Uint32 pixel,const SDL_PixelFormat* format,Uint8 *r,Uint8 *g,Uint8 *b,Uint8 *a) • Uint32 SDL_MapRGB(const SDL_PixelFormat* format,Uint8 r,Uint8 g, Uint8 b) • Uint32 SDL_MapRGBA(const SDL_PixelFormat* format,Uint8 r,Uint8 g, Uint8 b, Uint8 a) • Uint32 SDL_MasksToPixelFormatEnum(int bpp,Uint32 Rmask,Uint32 Gmask,Uint32 Bmask,Uint32 Amask) • SDL_bool SDL_PixelFormatEnumToMasks(Uint32 format,int *bpp,Uint32 *Rmask,Uint32 *Gmask,Uint32 *Bmask,Uint32 *Amask) • int SDL_SetPaletteColors(SDL_Palette *palette,const SDL_Color *colors,int firstcolor,int ncolors) • int SDL_SetPixelFormatPalette(SDL_PixelFormat *format,SDL_Palette *palette) • SDL_bool SDL_EnclosePoints(const SDL_Point* points,int count,const SDL_Rect *clip,SDL_Rect *result) • SDL_bool SDL_HasIntersection(const SDL_Rect *A,const SDL_Rect *B) • SDL_bool SDL_IntersectRect(const SDL_Rect *A,const SDL_Rect *B,SDL_Rect *result) • SDL_bool SDL_IntersectRectAndLine(const SDL_Rect *rect,int *X1,int *Y1,int *X2,int *Y2) • SDL_bool SDL_RectEquals(const SDL_Rect *a,const SDL_Rect *b) • void SDL_UnionRect(const SDL_Rect *A,const SDL_Rect *B,SDL_Rect *result) • int SDL_BlitScaled(SDL_Surface *src,const SDL_Rect *srcrect,SDL_Surface *dst,SDL_Rect *dstrect) • int SDL_BlitSurface(SDL_Surface src,const SDL_Rect srcrect,SDL_Surface *dst,SDL_Rect *dstrect) • int SDL_ConvertPixels(int width,int height,Uint32 src_format,const void *src,int src_pitch,Uint32 dst_format,void *dst,int dst_pitch) • SDL_Surface *SDL_ConvertSurface(SDL_Surface *src,const SDL_PixelFormat *fmt,Uint32 flags) • SDL_Surface *SDL_ConvertSurfaceFormat(SDL_Surface *src,Uint32 pixel_format,Uint32 flags) • SDL_Surface *SDL_CreateRGBSurface(Uint32 flags,int width,int height,int depth,Uint32 Rmask,Uint32 Gmask,Uint32 Bmask,Uint32 Amask) • SDL_Surface* SDL_CreateRGBSurfaceFrom(void *pixels,int width,int height,int depth,int pitch,Uint32 Rmask,Uint32 Gmask,Uint32 Bmask,Uint32 Amask) 661
- 685. Ring Documentation, Release1.4.1 • int SDL_FillRect(SDL_Surface *dst,const SDL_Rect *rect,Uint32 color) • int SDL_FillRects(SDL_Surface *dst,const SDL_Rect *rects,int count,Uint32 color) • void SDL_FreeSurface(SDL_Surface *surface) • void SDL_GetClipRect(SDL_Surface *surface,SDL_Rect *rect) • int SDL_GetColorKey(SDL_Surface *surface,Uint32 *key) • int SDL_GetSurfaceAlphaMod(SDL_Surface *surface,Uint8 *alpha) • int SDL_GetSurfaceBlendMode(SDL_Surface *surface,SDL_BlendMode *blendMode) • int SDL_GetSurfaceColorMod(SDL_Surface *surface,Uint8 *r,Uint8 *g,Uint8 *b) • SDL_Surface *SDL_LoadBMP(const char *file) • SDL_Surface *SDL_LoadBMP_RW(SDL_RWops *src,int freesrc) • int SDL_LockSurface(SDL_Surface *surface) • int SDL_LowerBlit(SDL_Surface *src,SDL_Rect *srcrect,SDL_Surface *dst,SDL_Rect *dstrect) • int SDL_LowerBlitScaled(SDL_Surface *src,SDL_Rect *srcrect,SDL_Surface *dst,SDL_Rect *dstrect) • SDL_bool SDL_MUSTLOCK(SDL_Surface *surface) • int SDL_SaveBMP(SDL_Surface *surface,const char *file) • int SDL_SaveBMP_RW(SDL_Surface *surface,SDL_RWops *dst,int freedst) • SDL_bool SDL_SetClipRect(SDL_Surface *surface,const SDL_Rect *rect) • int SDL_SetColorKey(SDL_Surface *surface,int flag,Uint32 key) • int SDL_SetSurfaceAlphaMod(SDL_Surface *surface,Uint8 alpha) • int SDL_SetSurfaceBlendMode(SDL_Surface *surface,SDL_BlendMode blendMode) • int SDL_SetSurfaceColorMod(SDL_Surface *surface,Uint8 r,Uint8 g,Uint8 b) • int SDL_SetSurfacePalette(SDL_Surface *surface,SDL_Palette *palette) • int SDL_SetSurfaceRLE(SDL_Surface *surface,int flag) • void SDL_UnlockSurface(SDL_Surface* surface) • SDL_bool SDL_GetWindowWMInfo(SDL_Window *window,SDL_SysWMinfo *info) • char *SDL_GetClipboardText(void) • SDL_bool SDL_HasClipboardText(void) • int SDL_SetClipboardText(const char *text) • void SDL_AddEventWatch(SDL_EventFilter filter,void *userdata) • void SDL_DelEventWatch(SDL_EventFilter filter,void *userdata) • Uint8 SDL_EventState(Uint32 type,int state) • void SDL_FilterEvents(SDL_EventFilter filter,void *userdata) • void SDL_FlushEvent(Uint32 type) • void SDL_FlushEvents(Uint32 minType,Uint32 maxType) • SDL_bool SDL_GetEventFilter(SDL_EventFilter *filter,void **userdata) • Uint8 SDL_GetEventState(Uint32 type) 662
- 686. Ring Documentation, Release1.4.1 • int SDL_GetNumTouchDevices(void) • int SDL_GetNumTouchFingers(SDL_TouchID touchID) • SDL_TouchID SDL_GetTouchDevice(int index) • SDL_Finger* SDL_GetTouchFinger(SDL_TouchID touchID,int index) • SDL_bool SDL_HasEvent(Uint32 type) • SDL_bool SDL_HasEvents(Uint32 minType,Uint32 maxType) • int SDL_LoadDollarTemplates(SDL_TouchID touchId,SDL_RWops *src) • int SDL_PeepEvents(SDL_Event *events,int numevents,SDL_eventaction action,Uint32 minType,Uint32 max- Type) • int SDL_PollEvent(SDL_Event *event) • void SDL_PumpEvents(void) • int SDL_PushEvent(SDL_Event *event) • SDL_bool SDL_QuitRequested(void) • int SDL_RecordGesture(SDL_TouchID touchId) • Uint32 SDL_RegisterEvents(int numevents) • int SDL_SaveAllDollarTemplates(SDL_RWops *dst) • int SDL_SaveDollarTemplate(SDL_GestureID gestureId,SDL_RWops *dst) • void SDL_SetEventFilter(SDL_EventFilter filter,void *userdata) • int SDL_WaitEvent(SDL_Event *event) • int SDL_WaitEventTimeout(SDL_Event *event,int timeout) • SDL_Keycode SDL_GetKeyFromName(const char * name) • SDL_Keycode SDL_GetKeyFromScancode(SDL_Scancode scancode) • const char * SDL_GetKeyName(SDL_Keycode key) • SDL_Window* SDL_GetKeyboardFocus(void) • const Uint8* SDL_GetKeyboardState(int* numkeys) • SDL_Keymod SDL_GetModState(void) • SDL_Scancode SDL_GetScancodeFromKey(SDL_Keycode key) • SDL_Scancode SDL_GetScancodeFromName(const char * name) • const char * SDL_GetScancodeName(SDL_Scancode scancode) • SDL_bool SDL_HasScreenKeyboardSupport(void) • SDL_bool SDL_IsScreenKeyboardShown(SDL_Window* window) • SDL_bool SDL_IsTextInputActive(void) • void SDL_SetModState(SDL_Keymod modstate) • void SDL_SetTextInputRect(SDL_Rect* rect) • void SDL_StartTextInput(void) • void SDL_StopTextInput(void) 663
- 687. Ring Documentation, Release1.4.1 • SDL_Cursor *SDL_CreateCursor(const Uint8 *data,const Uint8 *mask,int w,int h,int hot_x,int hot_y) • void SDL_FreeCursor(SDL_Cursor *cursor) • SDL_Cursor *SDL_GetCursor(void) • SDL_Cursor *SDL_GetDefaultCursor(void) • Uint32 SDL_GetMouseState(int *x,int * y) • SDL_bool SDL_GetRelativeMouseMode(void) • Uint32 SDL_GetRelativeMouseState(int *x,int *y) • void SDL_SetCursor(SDL_Cursor *cursor) • int SDL_SetRelativeMouseMode(SDL_bool enabled) • int SDL_ShowCursor(int toggle) • void SDL_JoystickClose(SDL_Joystick *joystick) • SDL_bool SDL_JoystickGetAttached(SDL_Joystick *joystick) • Sint16 SDL_JoystickGetAxis(SDL_Joystick *joystick,int axis) • int SDL_JoystickGetBall(SDL_Joystick *joystick,int ball,int *dx,int *dy) • Uint8 SDL_JoystickGetButton(SDL_Joystick *joystick,int button) • SDL_JoystickGUID SDL_JoystickGetDeviceGUID(int device_index) • SDL_JoystickGUID SDL_JoystickGetGUID(SDL_Joystick *joystick) • SDL_JoystickGUID SDL_JoystickGetGUIDFromString(const char *pchGUID) • void SDL_JoystickGetGUIDString(SDL_JoystickGUID guid,char *pszGUID,int cbGUID) • Uint8 SDL_JoystickGetHat(SDL_Joystick *joystick,int hat) • SDL_JoystickID SDL_JoystickInstanceID(SDL_Joystick *joystick) • const char *SDL_JoystickName(SDL_Joystick *joystick) • const char *SDL_JoystickNameForIndex(int device_index) • int SDL_JoystickNumAxes(SDL_Joystick *joystick) • int SDL_JoystickNumBalls(SDL_Joystick *joystick) • int SDL_JoystickNumButtons(SDL_Joystick *joystick) • int SDL_JoystickNumHats(SDL_Joystick *joystick) • SDL_Joystick *SDL_JoystickOpen(int device_index) • void SDL_JoystickUpdate(void) • int SDL_NumJoysticks(void) • int SDL_GameControllerAddMapping(const char *mappingString) • int SDL_GameControllerAddMappingsFromFile(const char *filename) • int SDL_GameControllerAddMappingsFromRW(SDL_RWops *rw,int freerw) • void SDL_GameControllerClose(SDL_GameController *gamecontroller) • int SDL_GameControllerEventState(int state) • Sint16 SDL_GameControllerGetAxis(SDL_GameController *gamecontroller,SDL_GameControllerAxis axis) 664
- 688. Ring Documentation, Release1.4.1 • SDL_GameControllerAxis SDL_GameControllerGetAxisFromString(const char *pchString) • SDL_GameControllerButtonBind SDL_GameControllerGetBindForAxis(SDL_GameController *gamecon- troller,SDL_GameControllerAxis axis) • SDL_GameControllerButtonBind SDL_GameControllerGetBindForButton(SDL_GameController *gamecon- troller,SDL_GameControllerButton button) • Uint8 SDL_GameControllerGetButton(SDL_GameController *gamecontroller,SDL_GameControllerButton button) • SDL_GameControllerButton SDL_GameControllerGetButtonFromString(const char *pchString) • SDL_Joystick *SDL_GameControllerGetJoystick(SDL_GameController *gamecontroller) • const char *SDL_GameControllerGetStringForAxis(SDL_GameControllerAxis axis) • const char *SDL_GameControllerGetStringForButton(SDL_GameControllerButton button) • char *SDL_GameControllerMapping(SDL_GameController *gamecontroller) • char *SDL_GameControllerMappingForGUID(SDL_JoystickGUID guid) • const char *SDL_GameControllerName(SDL_GameController *gamecontroller) • const char *SDL_GameControllerNameForIndex(int joystick_index) • SDL_GameController* SDL_GameControllerOpen(int joystick_index) • void SDL_GameControllerUpdate(void) • SDL_bool SDL_IsGameController(int joystick_index) • void SDL_HapticClose(SDL_Haptic* haptic) • void SDL_HapticDestroyEffect(SDL_Haptic *haptic,int effect) • int SDL_HapticEffectSupported(SDL_Haptic *haptic,SDL_HapticEffect *effect) • int SDL_HapticGetEffectStatus(SDL_Haptic *haptic,int effect) • int SDL_HapticIndex(SDL_Haptic *haptic) • const char *SDL_HapticName(int device_index) • int SDL_HapticNewEffect(SDL_Haptic *haptic,SDL_HapticEffect *effect) • int SDL_HapticNumAxes(SDL_Haptic *haptic) • int SDL_HapticNumEffects(SDL_Haptic *haptic) • int SDL_HapticNumEffectsPlaying(SDL_Haptic *haptic) • SDL_Haptic *SDL_HapticOpen(int device_index) • SDL_Haptic *SDL_HapticOpenFromJoystick(SDL_Joystick *joystick) • SDL_Haptic *SDL_HapticOpenFromMouse(void) • int SDL_HapticOpened(int device_index) • int SDL_HapticPause(SDL_Haptic *haptic) • unsigned int SDL_HapticQuery(SDL_Haptic *haptic) • int SDL_HapticRumbleInit(SDL_Haptic *haptic) • int SDL_HapticRumblePlay(SDL_Haptic *haptic,float strength,Uint32 length) • int SDL_HapticRumbleStop(SDL_Haptic *haptic) 665
- 689. Ring Documentation, Release1.4.1 • int SDL_HapticRumbleSupported(SDL_Haptic *haptic) • int SDL_HapticRunEffect(SDL_Haptic *haptic,int effect,Uint32 iterations) • int SDL_HapticSetAutocenter(SDL_Haptic *haptic,int autocenter) • int SDL_HapticSetGain(SDL_Haptic *haptic,int gain) • int SDL_HapticStopAll(SDL_Haptic *haptic) • int SDL_HapticStopEffect(SDL_Haptic *haptic,int effect) • int SDL_HapticUnpause(SDL_Haptic *haptic) • int SDL_HapticUpdateEffect(SDL_Haptic *haptic,int effect,SDL_HapticEffect *data) • int SDL_JoystickIsHaptic(SDL_Joystick *joystick) • int SDL_MouseIsHaptic(void) • int SDL_NumHaptics(void) • int SDL_AudioInit(const char * driver_name) • void SDL_AudioQuit(void) • int SDL_BuildAudioCVT(SDL_AudioCVT *cvt,SDL_AudioFormat src_format,Uint8 src_channels,int src_rate,SDL_AudioFormat dst_format,Uint8 dst_channels,int dst_rate) • void SDL_CloseAudioDevice(SDL_AudioDeviceID dev) • int SDL_ConvertAudio(SDL_AudioCVT *cvt) • void SDL_FreeWAV(Uint8 *audio_buf) • const char * SDL_GetAudioDeviceName(int index,int iscapture) • SDL_AudioStatus SDL_GetAudioDeviceStatus(SDL_AudioDeviceID dev) • const char * SDL_GetAudioDriver(int index) • SDL_AudioStatus SDL_GetAudioStatus(void) • const char * SDL_GetCurrentAudioDriver(void) • int SDL_GetNumAudioDevices(int iscapture) • int SDL_GetNumAudioDrivers(void) • SDL_AudioSpec *SDL_LoadWAV_RW(SDL_RWops *src,int freesrc,SDL_AudioSpec *spec,Uint8 **au- dio_buf,Uint32 *audio_len) • void SDL_LockAudio(void) • void SDL_LockAudioDevice(SDL_AudioDeviceID dev) • void SDL_MixAudio(Uint8 dst,const Uint8 src,Uint32 len,int volume) • void SDL_MixAudioFormat(Uint8 *dst,const Uint8 *src,SDL_AudioFormat format,Uint32 len,int volume) • int SDL_OpenAudio(SDL_AudioSpec *desired,SDL_AudioSpec *obtained) • SDL_AudioDeviceID SDL_OpenAudioDevice(const char *device,int iscapture,const SDL_AudioSpec *de- sired,SDL_AudioSpec *obtained,int allowed_changes) • void SDL_PauseAudio(int pause_on) • void SDL_PauseAudioDevice(SDL_AudioDeviceID dev,int pause_on) • void SDL_UnlockAudio(void) 666
- 690. Ring Documentation, Release1.4.1 • void SDL_UnlockAudioDevice(SDL_AudioDeviceID dev) • char *SDL_GetBasePath(void) • char *SDL_GetPrefPath(const char *org,const char *app) • SDL_RWops *SDL_AllocRW(void) • void SDL_FreeRW(SDL_RWops *area) • SDL_RWops SDL_RWFromConstMem(const void mem,int size) • SDL_RWops *SDL_RWFromFP(void *fp,SDL_bool autoclose) • SDL_RWops *SDL_RWFromFile(const char *file,const char *mode) • SDL_RWops *SDL_RWFromMem(void *mem,int size) • int SDL_RWclose(struct SDL_RWops *context) • size_t SDL_RWread(struct SDL_RWops *context,void *ptr,size_t size,size_t maxnum) • Sint64 SDL_RWseek(SDL_RWops *context,Sint64 offset,int whence) • Sint64 SDL_RWsize(SDL_RWops *context) • Sint64 SDL_RWtell(struct SDL_RWops *context) • size_t SDL_RWwrite(struct SDL_RWops *context,const void *ptr,size_t size,size_t num) • Uint16 SDL_ReadBE16(SDL_RWops *src) • Uint32 SDL_ReadBE32(SDL_RWops *src) • Uint64 SDL_ReadBE64(SDL_RWops *src) • Uint16 SDL_ReadLE16(SDL_RWops *src) • Uint32 SDL_ReadLE32(SDL_RWops *src) • Uint64 SDL_ReadLE64(SDL_RWops *src) • Uint8 SDL_ReadU8(SDL_RWops *src) • size_t SDL_WriteBE16(SDL_RWops *dst,Uint16 value) • size_t SDL_WriteBE32(SDL_RWops *dst,Uint32 value) • size_t SDL_WriteBE64(SDL_RWops *dst,Uint64 value) • size_t SDL_WriteLE16(SDL_RWops *dst,Uint16 value) • size_t SDL_WriteLE32(SDL_RWops *dst,Uint32 value) • size_t SDL_WriteLE64(SDL_RWops *dst,Uint64 value) • size_t SDL_WriteU8(SDL_RWops *dst,Uint8 value) • void *SDL_LoadFunction(void *handle,const char *name) • void *SDL_LoadObject(const char *sofile) • void SDL_UnloadObject(void *handle) • const char *SDL_GetPlatform(void) • int SDL_GetCPUCacheLineSize(void) • int SDL_GetCPUCount(void) • int SDL_GetSystemRAM(void) 667
- 691. Ring Documentation, Release1.4.1 • SDL_bool SDL_Has3DNow(void) • SDL_bool SDL_HasAVX(void) • SDL_bool SDL_HasMMX(void) • SDL_bool SDL_HasRDTSC(void) • SDL_bool SDL_HasSSE(void) • SDL_bool SDL_HasSSE2(void) • SDL_bool SDL_HasSSE3(void) • SDL_bool SDL_HasSSE41(void) • SDL_bool SDL_HasSSE42(void) • SDL_PowerState SDL_GetPowerInfo(int *secs,int *pct) • double SDL_acos(double x) • int IMG_Init(int flags) • void IMG_Quit(void) • SDL_Surface *IMG_Load(const char *file) • SDL_Surface *IMG_Load_RW(SDL_RWops *src, int freesrc) • SDL_Surface *IMG_LoadTyped_RW(SDL_RWops *src, int freesrc, char *type) • SDL_Surface *IMG_LoadCUR_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadBMP_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadPNM_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadXPM_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadXCF_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadPCX_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadGIF_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadJPG_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadTIF_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadPNG_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadTGA_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadLBM_RW(SDL_RWops *src) • SDL_Surface *IMG_LoadXV_RW(SDL_RWops *src) • SDL_Surface *IMG_ReadXPMFromArray(char **xpm) • int IMG_isCUR(SDL_RWops *src) • int IMG_isICO(SDL_RWops *src) • int IMG_isBMP(SDL_RWops *src) • int IMG_isPNM(SDL_RWops *src) • int IMG_isXPM(SDL_RWops *src) • int IMG_isXCF(SDL_RWops *src) 668
- 692. Ring Documentation, Release1.4.1 • int IMG_isPCX(SDL_RWops *src) • int IMG_isGIF(SDL_RWops *src) • int IMG_isJPG(SDL_RWops *src) • int IMG_isTIF(SDL_RWops *src) • int IMG_isPNG(SDL_RWops *src) • int IMG_isLBM(SDL_RWops *src) • int IMG_isXV(SDL_RWops *src) • int TTF_Init(void) • int TTF_WasInit(void) • void TTF_Quit(void) • TTF_Font *TTF_OpenFont(const char *file, int ptsize) • TTF_Font *TTF_OpenFontRW(SDL_RWops *src, int freesrc, int ptsize) • TTF_Font *TTF_OpenFontIndex(const char *file, int ptsize, long index) • TTF_Font *TTF_OpenFontIndexRW(SDL_RWops *src, int freesrc, int ptsize, long index) • void TTF_CloseFont(TTF_Font *font) • void TTF_ByteSwappedUNICODE(int swapped) • int TTF_GetFontStyle(TTF_Font *font) • void TTF_SetFontStyle(TTF_Font *font, int style) • int TTF_GetFontOutline(TTF_Font *font) • void TTF_SetFontOutline(TTF_Font *font, int outline) • int TTF_GetFontHinting(TTF_Font *font) • void TTF_SetFontHinting(TTF_Font *font, int hinting) • int TTF_GetFontKerning(TTF_Font *font) • void TTF_SetFontKerning(TTF_Font *font, int allowed) • int TTF_FontHeight(const TTF_Font *font) • int TTF_FontAscent(const TTF_Font *font) • int TTF_FontDescent(const TTF_Font *font) • int TTF_FontLineSkip(const TTF_Font *font) • long TTF_FontFaces(const TTF_Font *font) • int TTF_FontFaceIsFixedWidth(const TTF_Font *font) • char *TTF_FontFaceFamilyName(const TTF_Font *font) • char *TTF_FontFaceStyleName(const TTF_Font *font) • int TTF_GlyphIsProvided(const TTF_Font *font, Uint16 ch) • int TTF_GlyphMetrics(TTF_Font *font, Uint16 ch, int *minx, int *maxx, int *miny, int *maxy, int *advance) • int TTF_SizeText(TTF_Font *font, const char *text, int *w, int *h) • int TTF_SizeUTF8(TTF_Font *font, const char *text, int *w, int *h) 669
- 693. Ring Documentation, Release1.4.1 • int TTF_SizeUNICODE(TTF_Font *font, const Uint16 *text, int *w, int *h) • SDL_Surface *TTF_RenderText_Solid(TTF_Font *font, const char *text, SDL_Color fg) • SDL_Surface *TTF_RenderUTF8_Solid(TTF_Font *font, const char *text,SDL_Color fg) • SDL_Surface *TTF_RenderUNICODE_Solid(TTF_Font *font, const Uint16 *text,SDL_Color fg) • SDL_Surface *TTF_RenderGlyph_Solid(TTF_Font *font, Uint16 ch, SDL_Color fg) • SDL_Surface *TTF_RenderText_Shaded(TTF_Font *font, const char *text,SDL_Color fg, SDL_Color bg) • SDL_Surface *TTF_RenderUTF8_Shaded(TTF_Font *font, const char *text,SDL_Color fg, SDL_Color bg) • SDL_Surface *TTF_RenderUNICODE_Shaded(TTF_Font *font, const Uint16 *text,SDL_Color fg, SDL_Color bg) • SDL_Surface *TTF_RenderGlyph_Shaded(TTF_Font *font, Uint16 ch, SDL_Color fg,SDL_Color bg) • SDL_Surface *TTF_RenderText_Blended(TTF_Font *font, const char *text,SDL_Color fg) • SDL_Surface *TTF_RenderUTF8_Blended(TTF_Font *font, const char *text,SDL_Color fg) • SDL_Surface *TTF_RenderUNICODE_Blended(TTF_Font *font, const Uint16 *text,SDL_Color fg) • SDL_Surface *TTF_RenderGlyph_Blended(TTF_Font *font, Uint16 ch, SDL_Color fg) • int Mix_Init(int flags) • void Mix_Quit(void) • int Mix_OpenAudio(int frequency, Uint16 format, int channels, int chunksize) • void Mix_CloseAudio(void) • int Mix_QuerySpec(int *frequency, Uint16 *format, int *channels) • int Mix_GetNumChunkDecoders(void) • const char *Mix_GetChunkDecoder(int index) • Mix_Chunk *Mix_LoadWAV(char *file) • Mix_Chunk *Mix_LoadWAV_RW(SDL_RWops *src, int freesrc) • Mix_Chunk *Mix_QuickLoad_WAV(Uint8 *mem) • void Mix_FreeChunk(Mix_Chunk *chunk) • int Mix_AllocateChannels(int numchans) • int Mix_Volume(int channel, int volume) • int Mix_PlayChannel(int channel, Mix_Chunk *chunk, int loops) • int Mix_PlayChannelTimed(int channel, Mix_Chunk *chunk, int loops, int ticks) • int Mix_FadeInChannel(int channel, Mix_Chunk *chunk, int loops, int ms) • int Mix_FadeInChannelTimed(int channel, Mix_Chunk *chunk,int loops, int ms, int ticks) • void Mix_Pause(int channel) • void Mix_Resume(int channel) • int Mix_HaltChannel(int channel) • int Mix_ExpireChannel(int channel, int ticks) • int Mix_FadeOutChannel(int channel, int ms) 670
- 694. Ring Documentation, Release1.4.1 • int Mix_Paused(int channel) • Mix_Fading Mix_FadingChannel(int which) • Mix_Chunk *Mix_GetChunk(int channel) • int Mix_ReserveChannels(int num) • int Mix_GroupChannel(int which, int tag) • int Mix_GroupChannels(int from, int to, int tag) • int Mix_GroupCount(int tag) • int Mix_GroupAvailable(int tag) • int Mix_GroupOldest(int tag) • int Mix_GroupNewer(int tag) • int Mix_FadeOutGroup(int tag, int ms) • int Mix_HaltGroup(int tag) • int Mix_GetNumMusicDecoders(void) • const char *Mix_GetMusicDecoder(int index) • Mix_Music *Mix_LoadMUS(const char *file) • void Mix_FreeMusic(Mix_Music *music) • int Mix_PlayMusic(Mix_Music *music, int loops) • int Mix_FadeInMusic(Mix_Music *music, int loops, int ms) • int Mix_FadeInMusicPos(Mix_Music *music, int loops, int ms, double position) • int Mix_PlayingMusic(void) • int Mix_PausedMusic(void) • Mix_Fading Mix_FadingMusic(void) • void *Mix_GetMusicHookData(void) • int Mix_RegisterEffect(int chan, Mix_EffectFunc_t f, Mix_EffectDone_t d,void *arg) • int Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f) • int Mix_UnregisterAllEffects(int channel) • int Mix_SetDistance(int channel, Uint8 distance) • int Mix_SetPosition(int channel, Sint16 angle, Uint8 distance) • int Mix_SetReverseStereo(int channel, int flip) • int SDLNet_Init(void) • void SDLNet_Quit(void) • char *SDLNet_GetError(void) • void SDLNet_Write16(Uint16 value, void *area) • void SDLNet_Write32(Uint32 value, void *area) • Uint16 SDLNet_Read16(void *area) • Uint32 SDLNet_Read32(void *area) 671
- 695. Ring Documentation, Release1.4.1 • int SDLNet_ResolveHost(IPaddress *address, const char *host, Uint16 port) • const char *SDLNet_ResolveIP(IPaddress *address) • TCPsocket SDLNet_TCP_Open(IPaddress *ip) • void SDLNet_TCP_Close(TCPsocket sock) • TCPsocket SDLNet_TCP_Accept(TCPsocket server) • IPaddress *SDLNet_TCP_GetPeerAddress(TCPsocket sock) • int SDLNet_TCP_Send(TCPsocket sock, const void *data, int len) • int SDLNet_TCP_Recv(TCPsocket sock, void *data, int maxlen) • UDPsocket SDLNet_UDP_Open(Uint16 port) • void SDLNet_UDP_Close(UDPsocket sock) • int SDLNet_UDP_Bind(UDPsocket sock, int channel, IPaddress *address) • void SDLNet_UDP_Unbind(UDPsocket sock, int channel) • IPaddress *SDLNet_UDP_GetPeerAddress(UDPsocket sock, int channel) • int SDLNet_UDP_Send(UDPsocket sock, int channel, UDPpacket *packet) • int SDLNet_UDP_Recv(UDPsocket sock, UDPpacket *packet) • int SDLNet_UDP_SendV(UDPsocket sock, UDPpacket **packetV, int npackets) • int SDLNet_UDP_RecvV(UDPsocket sock, UDPpacket **packetV) • UDPpacket *SDLNet_AllocPacket(int size) • int SDLNet_ResizePacket(UDPpacket *packet, int size) • void SDLNet_FreePacket(UDPpacket *packet) • UDPpacket **SDLNet_AllocPacketV(int howmany, int size) • void SDLNet_FreePacketV(UDPpacket **packetV) • SDLNet_SocketSet SDLNet_AllocSocketSet(int maxsockets) • void SDLNet_FreeSocketSet(SDLNet_SocketSet set) • int SDLNet_AddSocket(SDLNet_SocketSet set, SDLNet_GenericSocket sock) • int SDLNet_TCP_AddSocket(SDLNet_SocketSet set, TCPsocket sock) • int SDLNet_UDP_AddSocket(SDLNet_SocketSet set, UDPsocket sock) • int SDLNet_DelSocket(SDLNet_SocketSet set, SDLNet_GenericSocket sock) • int SDLNet_TCP_DelSocket(SDLNet_SocketSet set, TCPsocket sock) • int SDLNet_UDP_DelSocket(SDLNet_SocketSet set, UDPsocket sock) • int SDLNet_CheckSockets(SDLNet_SocketSet set, Uint32 timeout) • int SDLNet_SocketReady(TCPsocket sock) • int circleRGBA(SDL_Renderer * renderer, Sint16 x, Sint16 y, Sint16 rad, Uint8 r, Uint8 g, Uint8 b, Uint8 a) 672
- 696. CHAPTER SEVENTY RINGQT CLASSES REFERENCE 70.1QApp Class C++ Reference : http://doc.qt.io/qt-5/QApplication.html • void exec(void) • void quit(void) • void processEvents(void) • void styleWindows(void) • void styleWindowsVista(void) • void styleFusion(void) • void styleFusionBlack(void) • void styleFusionCustom(QColor,QColor,QColor,QColor,QColor,QColor,QColor,QColor,QColor,QColor,QColor,QColor) • void closeAllWindows(void) • Qt::KeyboardModifiers keyboardModifiers(void) 70.2 QDesktopServices Class C++ Reference : http://doc.qt.io/qt-5/QDesktopServices.html • bool openUrl(QUrl) • void setUrlHandler(QString, QObject *receiver, const char *method) • void unsetUrlHandler(QString) 70.3 QTest Class C++ Reference : http://doc.qt.io/qt-5/QTest.html • void qsleep(int) 673
- 697. Ring Documentation, Release1.4.1 70.4 QObject Class C++ Reference : http://doc.qt.io/qt-5/QObject.html Parameters : void • bool blockSignals(bool block) • QObjectList children(void) • void dumpObjectInfo(void) • void dumpObjectTree(void) • bool inherits(const char *className) • void installEventFilter(QObject *filterObj) • bool isWidgetType(void) • void killTimer(int id) • void moveToThread(QThread *targetThread) • QString objectName(void) • QObject *parent(void) • QVariant property(const char *name) • void removeEventFilter(QObject *obj) • void setObjectName(QString) • void setParent(QObject *parent) • bool setProperty(const char *name, QVariant) • bool signalsBlocked(void) • int startTimer(int interval) • QThread *thread(void) • void deleteLater(void) 70.5 QWidget Class C++ Reference : http://doc.qt.io/qt-5/QWidget.html Parameters : void Parent Class : QObject • bool acceptDrops(void) • QString accessibleDescription(void) • QString accessibleName(void) • void activateWindow(void) • void addAction(QAction *action) • void adjustSize(void) • bool autoFillBackground(void) 70.4. QObject Class 674
- 698. Ring Documentation, Release1.4.1 • int backgroundRole(void) • QSize baseSize(void) • QWidget *childAt(int x, int y) • QRect childrenRect(void) • QRegion childrenRegion(void) • void clearFocus(void) • void clearMask(void) • QMargins contentsMargins(void) • QRect contentsRect(void) • int contextMenuPolicy(void) • QCursor cursor(void) • int effectiveWinId(void) • void ensurePolished(void) • int focusPolicy(void) • QWidget *focusProxy(void) • QWidget *focusWidget(void) • QFont font(void) • QFontInfo fontInfo(void) • int foregroundRole(void) • QRect frameGeometry(void) • QSize frameSize(void) • QRect geometry(void) • void getContentsMargins(int *left, int *top, int *right, int *bottom) • void grabGesture(Qt::GestureType gesture, Qt::GestureFlag flags) • void grabKeyboard(void) • void grabMouse(void) • int grabShortcut(QKeySequence , Qt::ShortcutContext context) • QGraphicsEffect *graphicsEffect(void) • QGraphicsProxyWidget *graphicsProxyWidget(void) • bool hasFocus(void) • bool hasMouseTracking(void) • int height(void) • int heightForWidth(int w) • int inputMethodHints(void) • QVariant inputMethodQuery(Qt::InputMethodQuery query) • void insertAction(QAction *before, QAction *action) 70.5. QWidget Class 675
- 699. Ring Documentation, Release1.4.1 • bool isActiveWindow(void) • bool isAncestorOf(QWidget *child) • bool isEnabled(void) • bool isEnabledTo(QWidget *ancestor) • bool isFullScreen(void) • bool isHidden(void) • bool isMaximized(void) • bool isMinimized(void) • bool isModal(void) • bool isVisible(void) • bool isVisibleTo(QWidget *ancestor) • bool isWindow(void) • bool isWindowModified(void) • QLayout *layout(void) • int layoutDirection(void) • QLocale locale(void) • QPoint mapFrom(QWidget *parent, QPoint) • QPoint mapFromGlobal(QPoint) • QPoint mapFromParent(QPoint) • QPoint mapTo(QWidget *parent, QPoint) • QPoint mapToGlobal(QPoint pos) • QPoint mapToParent(QPoint pos) • QRegion mask(void) • int maximumHeight(void) • QSize maximumSize(void) • int maximumWidth(void) • int minimumHeight(void) • QSize minimumSize(void) • int minimumWidth(void) • void move(int x, int y) • QWidget *nativeParentWidget(void) • QWidget *nextInFocusChain(void) • QRect normalGeometry(void) • void overrideWindowFlags(Qt::WindowType flags) • QPalette palette(void) • QWidget *parentWidget(void) 70.5. QWidget Class 676
- 700. Ring Documentation, Release1.4.1 • QPoint pos(void) • QWidget *previousInFocusChain(void) • QRect rect(void) • void releaseKeyboard(void) • void releaseMouse(void) • void releaseShortcut(int id) • void removeAction(QAction *action) • void render(QPaintDevice *target, QPoint,QRegion, QWidget::RenderFlag) • void repaint(void) • void resize(int w, int h) • bool restoreGeometry(QByteArray) • QByteArray saveGeometry(void) • void scroll(int dx, int dy) • void setAcceptDrops(bool on) • void setAccessibleDescription(QString) • void setAccessibleName(QString) • void setAttribute(Qt::WidgetAttribute attribute, bool on) • void setAutoFillBackground(bool enabled) • void setBackgroundRole(QPalette::ColorRole role) • void setBaseSize(int basew, int baseh) • void setContentsMargins(int left, int top, int right, int bottom) • void setContextMenuPolicy(Qt::ContextMenuPolicy policy) • void setCursor(QCursor) • void setFixedHeight(int h) • void setFixedSize(int w, int h) • void setFixedWidth(int w) • void setFocus(Qt::FocusReason reason) • void setFocusPolicy(Qt::FocusPolicy policy) • void setFocusProxy(QWidget *w) • void setFont(QFont) • void setForegroundRole(QPalette::ColorRole role) • void setGeometry(int x, int y, int w, int h) • void setGraphicsEffect(QGraphicsEffect *effect) • void setInputMethodHints(Qt::InputMethodHint hints) • void setLayout(QLayout *layout) • void setLayoutDirection(Qt::LayoutDirection direction) 70.5. QWidget Class 677
- 701. Ring Documentation, Release1.4.1 • void setLocale(QLocale) • void setMask(QBitmap) • void setMaximumHeight(int maxh) • void setMaximumSize(int maxw, int maxh) • void setMaximumWidth(int maxw) • void setMinimumHeight(int minh) • void setMinimumSize(int minw, int minh) • void setMinimumWidth(int minw) • void setMouseTracking(bool enable) • void setPalette(QPalette) • void setParent(QWidget *parent) • void setShortcutAutoRepeat(int id, bool enable) • void setShortcutEnabled(int id, bool enable) • void setSizeIncrement(int w, int h) • void setSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) • void setStatusTip(QString) • void setStyle(QStyle *style) • void setToolTip(QString) • void setUpdatesEnabled(bool enable) • void setWhatsThis(QString) • void setWindowFilePath(QString) • void setWindowFlags(Qt::WindowType type) • void setWindowIcon(QIcon) • void setWindowIconText(QString) • void setWindowModality(Qt::WindowModality windowModality) • void setWindowOpacity(double level) • void setWindowRole(QString) • void setWindowState(Qt::WindowState windowState) • QSize size(void) • QSize sizeIncrement(void) • QSizePolicy sizePolicy(void) • void stackUnder(QWidget *w) • QString statusTip(void) • QStyle *style(void) • QString styleSheet(void) • bool testAttribute(Qt::WidgetAttribute attribute) 70.5. QWidget Class 678
- 702. Ring Documentation, Release1.4.1 • QString toolTip(void) • bool underMouse(void) • void ungrabGesture(Qt::GestureType gesture) • void unsetCursor(void) • void unsetLayoutDirection(void) • void unsetLocale(void) • void update(int x, int y, int w, int h) • void updateGeometry(void) • bool updatesEnabled(void) • QRegion visibleRegion(void) • QString whatsThis(void) • int width(void) • int winId(void) • QWidget *window(void) • QString windowFilePath(void) • int windowFlags(void) • QIcon windowIcon(void) • QString windowIconText(void) • int windowModality(void) • double windowOpacity(void) • QString windowRole(void) • int windowState(void) • QString windowTitle(void) • int windowType(void) • int x(void) • int y(void) • bool close(void) • void hide(void) • void lower(void) • void raise(void) • void setDisabled(bool disable) • void setEnabled(bool) • void setHidden(bool hidden) • void setStyleSheet(QString) • void setWindowModified(bool) • void setWindowTitle(QString) 70.5. QWidget Class 679
- 703. Ring Documentation, Release1.4.1 • void show(void) • void showFullScreen(void) • void showMaximized(void) • void showMinimized(void) • void showNormal(void) • QWidget *find(int id) • QWidget *keyboardGrabber(void) • QWidget *mouseGrabber(void) • void setTabOrder(QWidget *first, QWidget *second) 70.6 QLabel Class C++ Reference : http://doc.qt.io/qt-5/QLabel.html Parameters : QWidget * Parent Class : QWidget • QWidget *buddy(void) • bool hasScaledContents(void) • bool hasSelectedText(void) • int indent(void) • int margin(void) • QMovie *movie(void) • bool openExternalLinks(void) • QPicture *picture(void) • QPixmap *pixmap(void) • QString selectedText(void) • int selectionStart(void) • void setAlignment(Qt::AlignmentFlag) • void setBuddy(QWidget *buddy) • void setIndent(int) • void setMargin(int) • void setOpenExternalLinks(bool open) • void setScaledContents(bool) • void setSelection(int start, int length) • void setTextFormat(Qt::TextFormat) • void setTextInteractionFlags(Qt::TextInteractionFlag flags) • void setWordWrap(bool on) 70.6. QLabel Class 680
- 704. Ring Documentation, Release1.4.1 • QString text(void) • int textFormat(void) • int textInteractionFlags(void) • bool wordWrap(void) • void clear(void) • void setMovie(QMovie *movie) • void setNum(double num) • void setPicture(QPicture) • void setPixmap(QPixmap) • void setText(QString) 70.7 QPushButton Class C++ Reference : http://doc.qt.io/qt-5/QPushButton.html Parameters : QWidget * Parent Class : QAbstractButton • void setClickEvent(const char *) • void setIcon(QIcon) • void setIconSize(QSize) • const char *getClickEvent(void) 70.8 QBitmap Class C++ Reference : http://doc.qt.io/qt-5/QBitmap.html Parameters : void Parent Class : QPixmap • void clear(void) • void swap(QBitmap) • QBitmap transformed(QTransform) • QBitmap fromData(QSize, const uchar * bits, QImage::Format monoFormat) • QBitmap fromImage(QImage, Qt::ImageConversionFlags flags) 70.9 QPixmap Class C++ Reference : http://doc.qt.io/qt-5/QPixmap.html Parameters : const char * • QPixmap copy(int x, int y, int width, int height) 70.7. QPushButton Class 681
- 705. Ring Documentation, Release1.4.1 • QPixmap scaled(int width, int height, Qt::AspectRatioMode aspectRatioMode, Qt::TransformationMode trans- formMode) • int width(void) • int height(void) • QBitmap createMaskFromColor(QColor , Qt::MaskMode) • QBitmap mask(void) • void setMask(QBitmap) • void fill(QColor) • QPixmap fromImage(QImage,Qt::ImageConversionFlags) • bool load(QString, const char *, Qt::ImageConversionFlags ) 70.10 QPixmap2 Class C++ Reference : http://doc.qt.io/qt-5/QPixmap2.html Parameters : int width, int height Parent Class : QPixmap 70.11 QIcon Class C++ Reference : http://doc.qt.io/qt-5/QIcon.html Parameters : QPixmap 70.12 QSize Class C++ Reference : http://doc.qt.io/qt-5/QSize.html Parameters : int width, int height 70.13 QLineEdit Class C++ Reference : http://doc.qt.io/qt-5/QLineEdit.html Parameters : QWidget * Parent Class : QWidget • int alignment(void) • void backspace(void) • QCompleter *completer(void) • QMenu *createStandardContextMenu(void) • void cursorBackward(bool mark, int steps) 70.10. QPixmap2 Class 682
- 706. Ring Documentation, Release1.4.1 • void cursorForward(bool mark, int steps) • int cursorMoveStyle(void) • int cursorPosition(void) • int cursorPositionAt(QPoint) • void cursorWordBackward(bool mark) • void cursorWordForward(bool mark) • void del(void) • void deselect(void) • QString displayText(void) • bool dragEnabled(void) • int echoMode(void) • void end(bool mark) # In RingQt use : void endtext(bool mark) • void getTextMargins(int *left, int *top, int *right, int *bottom) • bool hasAcceptableInput(void) • bool hasFrame(void) • bool hasSelectedText(void) • void home(bool mark) • QString inputMask(void) • void insert(QString) • bool isModified(void) • bool isReadOnly(void) • bool isRedoAvailable(void) • bool isUndoAvailable(void) • int maxLength(void) • QString placeholderText(void) • QString selectedText(void) • int selectionStart(void) • void setAlignment(Qt::AlignmentFlag flag) • void setCompleter(QCompleter *c) • void setCursorMoveStyle(Qt::CursorMoveStyle style) • void setCursorPosition(int) • void setDragEnabled(bool b) • void setEchoMode(QLineEdit::EchoMode) • void setFrame(bool) • void setInputMask(QString) • void setMaxLength(int) 70.13. QLineEdit Class 683
- 707. Ring Documentation, Release1.4.1 • void setModified(bool) • void setPlaceholderText(QString) • void setReadOnly(bool) • void setSelection(int start, int length) • void setTextMargins(int left, int top, int right, int bottom) • void setValidator(QValidator *v) • QString text(void) • QMargins textMargins(void) • QValidator *validator(void) • void clear(void) • void copy(void) • void cut(void) • void paste(void) • void redo(void) • void selectAll(void) • void setText(QString) • void undo(void) • void setTextChangedEvent(const char *) • void setcursorPositionChangedEvent(const char *) • void seteditingFinishedEvent(const char *) • void setreturnPressedEvent(const char *) • void setselectionChangedEvent(const char *) • void settextEditedEvent(const char *) • const char *getTextChangedEvent(void) • const char *getcursorPositionChangedEvent(void) • const char *geteditingFinishedEvent(void) • const char *getreturnPressedEvent(void) • const char *getselectionChangedEvent(void) • const char *gettextEditedEvent(void) 70.14 QVBoxLayout Class C++ Reference : http://doc.qt.io/qt-5/QVBoxLayout.html Parameters : void Parent Class : QBoxLayout • void addLayout(QLayout *) 70.14. QVBoxLayout Class 684
- 708. Ring Documentation, Release1.4.1 70.15 QHBoxLayout Class C++ Reference : http://doc.qt.io/qt-5/QHBoxLayout.html Parameters : void Parent Class : QBoxLayout • void addLayout(QLayout *) 70.16 QTextEdit Class C++ Reference : http://doc.qt.io/qt-5/QTextEdit.html Parameters : QWidget * Parent Class : QAbstractScrollArea • bool acceptRichText(void) • int alignment(void) • QString anchorAt(QPoint) • bool canPaste(void) • QTextCharFormat currentCharFormat(void) • QFont currentFont(void) • QTextCursor cursorForPosition(QPoint) • QRect cursorRect(void) • int cursorWidth(void) • QTextDocument *document(void) • QString documentTitle(void) • void ensureCursorVisible(void) • bool find(QString, QTextDocument::FindFlag) • QString fontFamily(void) • bool fontItalic(void) • double fontPointSize(void) • bool fontUnderline(void) • int fontWeight(void) • bool isReadOnly(void) • bool isUndoRedoEnabled(void) • int lineWrapColumnOrWidth(void) • QVariant loadResource(int, QUrl) • void mergeCurrentCharFormat(QTextCharFormat) • void moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode) • bool overwriteMode(void) 70.15. QHBoxLayout Class 685
- 709. Ring Documentation, Release1.4.1 • void print(QPrinter * printer) • void setAcceptRichText(bool accept) • void setCurrentCharFormat(QTextCharFormat) • void setCursorWidth(int width) • void setDocument(QTextDocument *document) • void setDocumentTitle(QString) • void setLineWrapColumnOrWidth(int w) • void setLineWrapMode(QTextEdit::LineWrapMode) • void setOverwriteMode(bool overwrite) • void setReadOnly(bool) • void setTabChangesFocus(bool) • void setTabStopWidth(int width) • void setTextCursor(QTextCursor) • void setTextInteractionFlags(Qt::TextInteractionFlag flags) • void setUndoRedoEnabled(bool enable) • void setWordWrapMode(QTextOption::WrapMode policy) • bool tabChangesFocus(void) • int tabStopWidth(void) • QColor textBackgroundColor(void) • QColor textColor(void) • QTextCursor textCursor(void) • int textInteractionFlags(void) • QString toHtml(void) • QString toPlainText(void) • int wordWrapMode(void) • void append(QString) • void clear(void) • void copy(void) • void cut(void) • void insertHtml(QString) • void insertPlainText(QString) • void paste(void) • void redo(void) • void scrollToAnchor(QString) • void selectAll(void) • void setAlignment(Qt::AlignmentFlag a) 70.16. QTextEdit Class 686
- 710. Ring Documentation, Release1.4.1 • void setCurrentFont(QFont) • void setFontFamily(QString) • void setFontItalic(bool italic) • void setFontPointSize(double s) • void setFontUnderline(bool underline) • void setFontWeight(int weight) • void setHtml(QString) • void setPlainText(QString) • void setText(QString) • void setTextBackgroundColor(QColor) • void setTextColor(QColor) • void undo(void) • void zoomIn(int range) • void zoomOut(int range) • void setcopyAvailableEvent(const char *) • void setcurrentCharFormatChangedEvent(const char *) • void setcursorPositionChangedEvent(const char *) • void setredoAvailableEvent(const char *) • void setselectionChangedEvent(const char *) • void settextChangedEvent(const char *) • void setundoAvailableEvent(const char *) • const char *getcopyAvailableEvent(void) • const char *getcurrentCharFormatChangedEvent(void) • const char *getcursorPositionChangedEvent(void) • const char *getredoAvailableEvent(void) • const char *getselectionChangedEvent(void) • const char *gettextChangedEvent(void) • const char *getundoAvailableEvent(void) • void cyanline(void) • void setactivelinecolor(QColor) 70.17 QListWidget Class C++ Reference : http://doc.qt.io/qt-5/QListWidget.html Parameters : QWidget * Parent Class : QListView 70.17. QListWidget Class 687
- 711. Ring Documentation, Release1.4.1 • void addItem(QString) • int count(void) • void editItem(QListWidgetItem *item) • bool isSortingEnabled(void) • QListWidgetItem *item(int row) • QListWidgetItem *itemAt(int x, int y) • QWidget *itemWidget(QListWidgetItem *item) • void openPersistentEditor(QListWidgetItem *item) • void removeItemWidget(QListWidgetItem *item) • int row(QListWidgetItem *item) • void setCurrentRow(int row, QItemSelectionModel::SelectionFlag command) • void setItemWidget(QListWidgetItem *item, QWidget *widget) • void setSortingEnabled(bool enable) • void sortItems(Qt::SortOrder order) • QListWidgetItem *takeItem(int row) • QRect visualItemRect(QListWidgetItem *item) • void clear(void) • void scrollToItem(QListWidgetItem *item,QAbstractItemView::ScrollHint hint) • void setcurrentItemChangedEvent(const char *) • void setcurrentRowChangedEvent(const char *) • void setcurrentTextChangedEvent(const char *) • void setitemActivatedEvent(const char *) • void setitemChangedEvent(const char *) • void setitemClickedEvent(const char *) • void setitemDoubleClickedEvent(const char *) • void setitemEnteredEvent(const char *) • void setitemPressedEvent(const char *) • void setitemSelectionChangedEvent(const char *) • const char *getcurrentItemChangedEvent(void) • const char *getcurrentRowChangedEvent(void) • const char *getcurrentTextChangedEvent(void) • const char *getitemActivatedEvent(void) • const char *getitemChangedEvent(void) • const char *getitemClickedEvent(void) • const char *getitemDoubleClickedEvent(void) • const char *getitemEnteredEvent(void) 70.17. QListWidget Class 688
- 712. Ring Documentation, Release1.4.1 • const char *getitemPressedEvent(void) • const char *getitemSelectionChangedEvent(void) 70.18 QTreeView Class C++ Reference : http://doc.qt.io/qt-5/QTreeView.html Parameters : QWidget * Parent Class : QAbstractItemView • bool allColumnsShowFocus(void) • int autoExpandDelay(void) • int columnAt(int x) • int columnViewportPosition(int column) • int columnWidth(int column) • bool expandsOnDoubleClick(void) • QHeaderView *header(void) • int indentation(void) • QModelIndex indexAbove(QModelIndex) • QModelIndex indexBelow(QModelIndex) • bool isAnimated(void) • bool isColumnHidden(int column) • bool isExpanded(QModelIndex) • bool isFirstColumnSpanned(int row, QModelIndex) • bool isHeaderHidden(void) • bool isRowHidden(int row,QModelIndex) • bool isSortingEnabled(void) • bool itemsExpandable(void) • bool rootIsDecorated(void) • void setAllColumnsShowFocus(bool enable) • void setAnimated(bool enable) • void setAutoExpandDelay(int delay) • void setColumnHidden(int column, bool hide) • void setColumnWidth(int column, int width) • void setExpanded(QModelIndex, bool expanded) • void setExpandsOnDoubleClick(bool enable) • void setFirstColumnSpanned(int row, QModelIndex, bool span) • void setHeader(QHeaderView * header) 70.18. QTreeView Class 689
- 713. Ring Documentation, Release1.4.1 • void setHeaderHidden(bool hide) • void setIndentation(int i) • void setItemsExpandable(bool enable) • void setRootIsDecorated(bool show) • void setRowHidden(int row,QModelIndex, bool hide) • void setSortingEnabled(bool enable) • void setUniformRowHeights(bool uniform) • void setWordWrap(bool on) • void sortByColumn(int column,Qt::SortOrder order) • bool uniformRowHeights(void) • bool wordWrap(void) • void dataChanged(QModelIndex,QModelIndex) • QModelIndex indexAt(QPoint) • void keyboardSearch(QString) • void reset(void) • void scrollTo(QModelIndex, QAbstractItemView::ScrollHint) • void selectAll(void) • void setModel(QAbstractItemModel *model) • void setRootIndex(QModelIndex) • void setSelectionModel(QItemSelectionModel *selectionModel) • QRect visualRect(QModelIndex) • void collapse(QModelIndex) • void collapseAll(void) • void expand(QModelIndex) • void expandAll(void) • void expandToDepth(int depth) • void hideColumn(int column) • void resizeColumnToContents(int column) • void showColumn(int column) • void setcollapsedEvent(const char *) • void setexpandedEvent(const char *) • void setactivatedEvent(const char *) • void setclickedEvent(const char *) • void setdoubleClickedEvent(const char *) • void setenteredEvent(const char *) • void setpressedEvent(const char *) 70.18. QTreeView Class 690
- 714. Ring Documentation, Release1.4.1 • void setviewportEnteredEvent(const char *) • const char *getcollapsedEvent(void) • const char *getexpandedEvent(void) • const char *getactivatedEvent(void) • const char *getclickedEvent(void) • const char *getdoubleClickedEvent(void) • const char *getenteredEvent(void) • const char *getpressedEvent(void) • const char *getviewportEnteredEvent(void) 70.19 QDir Class C++ Reference : http://doc.qt.io/qt-5/QDir.html Parameters : void • void setNameFilters(QStringList) 70.20 QFileSystemModel Class C++ Reference : http://doc.qt.io/qt-5/QFileSystemModel.html Parameters : void • QIcon fileIcon(QModelIndex) • QFileInfo fileInfo(QModelIndex) • QString fileName(QModelIndex) • QString filePath(QModelIndex) • int filter(void) • QFileIconProvider *iconProvider(void) • QModelIndex index(QString, int column) • bool isDir(QModelIndex) • bool isReadOnly(void) • QDateTime lastModified(QModelIndex) • QModelIndex mkdir(QModelIndex,QString) • QVariant myComputer(int role) • bool nameFilterDisables(void) • QStringList nameFilters(void) • int permissions(QModelIndex) • bool remove(QModelIndex) • bool resolveSymlinks(void) 70.19. QDir Class 691
- 715. Ring Documentation, Release1.4.1 • bool rmdir(QModelIndex) • QDir rootDirectory(void) • QString rootPath(void) • void setFilter(QDir::Filter filters) • void setIconProvider(QFileIconProvider *provider) • void setNameFilterDisables(bool enable) • void setNameFilters(QStringList) • void setReadOnly(bool enable) • void setResolveSymlinks(bool enable) • QModelIndex setRootPath(QString) • int size(QModelIndex) • QString type(QModelIndex) • bool canFetchMore(QModelIndex) • int columnCount(void) • QVariant data( QModelIndex index, int role) • bool dropMimeData( QMimeData *data, Qt::DropAction action, int row, int column, QModelIndex parent) • void fetchMore( QModelIndex parent) • int flags( QModelIndex index) • bool hasChildren( QModelIndex parent ) • QVariant headerData(int section, Qt::Orientation orientation, int role ) • QMimeData * mimeData( QModelIndexList indexes) • QStringList mimeTypes(void) • QModelIndex parent( QModelIndex index) • int rowCount( QModelIndex parent) • bool setData( QModelIndex idx, QVariant value, int role) • void sort(int column, Qt::SortOrder order ) • int supportedDropActions(void) 70.21 QTreeWidget Class C++ Reference : http://doc.qt.io/qt-5/QTreeWidget.html Parameters : QWidget * Parent Class : QTreeView • void addTopLevelItem(QTreeWidgetItem *item) • void closePersistentEditor(QTreeWidgetItem *item, int column) • int columnCount(void) 70.21. QTreeWidget Class 692
- 716. Ring Documentation, Release1.4.1 • int currentColumn(void) • QTreeWidgetItem *currentItem(void) • void editItem(QTreeWidgetItem *item, int column) • QTreeWidgetItem *headerItem(void) • int indexOfTopLevelItem(QTreeWidgetItem *item) • void insertTopLevelItem(int index, QTreeWidgetItem *item) • QTreeWidgetItem *invisibleRootItem(void) • bool isFirstItemColumnSpanned( QTreeWidgetItem *item) • QTreeWidgetItem *itemAbove(QTreeWidgetItem *item) • QTreeWidgetItem *itemAt(int x, int y) • QTreeWidgetItem *itemBelow(QTreeWidgetItem *item) • QWidget *itemWidget(QTreeWidgetItem *item, int column) • void openPersistentEditor(QTreeWidgetItem *item, int column) • void removeItemWidget(QTreeWidgetItem *item, int column) • void setColumnCount(int columns) • void setCurrentItem(QTreeWidgetItem * item, QItemSelectionModel::SelectionFlag column) • void setFirstItemColumnSpanned(QTreeWidgetItem *item, bool span) • void setHeaderItem(QTreeWidgetItem *item) • void setHeaderLabel(QString) • void setHeaderLabels(QStringList) • void setItemWidget(QTreeWidgetItem *item, int column, QWidget * widget) • int sortColumn(void) • void sortItems(int column, Qt::SortOrder order) • QTreeWidgetItem *takeTopLevelItem(int index) • QTreeWidgetItem *topLevelItem(int index) • int topLevelItemCount(void) • QRect visualItemRect(QTreeWidgetItem *item) • void setSelectionModel(QItemSelectionModel *selectionModel) • void clear(void) • void collapseItem(QTreeWidgetItem *item) • void expandItem(QTreeWidgetItem *item) • void scrollToItem(QTreeWidgetItem *item, QAbstractItemView::ScrollHint hint) • void setcollapsedEvent(const char *) • void setexpandedEvent(const char *) • void setactivatedEvent(const char *) • void setclickedEvent(const char *) 70.21. QTreeWidget Class 693
- 717. Ring Documentation, Release1.4.1 • void setdoubleClickedEvent(const char *) • void setenteredEvent(const char *) • void setpressedEvent(const char *) • void setviewportEnteredEvent(const char *) • void setcurrentItemChangedEvent(const char *) • void setitemActivatedEvent(const char *) • void setitemChangedEvent(const char *) • void setitemClickedEvent(const char *) • void setitemCollapsedEvent(const char *) • void setitemDoubleClickedEvent(const char *) • void setitemEnteredEvent(const char *) • void setitemExpandedEvent(const char *) • void setitemPressedEvent(const char *) • void setitemSelectionChangedEvent(const char *) • const char *getcollapsedEvent(void) • const char *getexpandedEvent(void) • const char *getactivatedEvent(void) • const char *getclickedEvent(void) • const char *getdoubleClickedEvent(void) • const char *getenteredEvent(void) • const char *getpressedEvent(void) • const char *getviewportEnteredEvent(void) • const char *getcurrentItemChangedEvent(void) • const char *getitemActivatedEvent(void) • const char *getitemChangedEvent(void) • const char *getitemClickedEvent(void) • const char *getitemCollapsedEvent(void) • const char *getitemDoubleClickedEvent(void) • const char *getitemEnteredEvent(void) • const char *getitemExpandedEvent(void) • const char *getitemPressedEvent(void) • const char *getitemSelectionChangedEvent(void) 70.21. QTreeWidget Class 694
- 718. Ring Documentation, Release1.4.1 70.22 QTreeWidgetItem Class C++ Reference : http://doc.qt.io/qt-5/QTreeWidgetItem.html Parameters : void • void addChild(QTreeWidgetItem *child) • QBrush background(int column) • int checkState(int column) • QTreeWidgetItem *child(int index) • int childCount(void) • int childIndicatorPolicy(void) • QTreeWidgetItem *clone(void) • int columnCount(void) • QVariant data(int column, int role) • int flags(void) • QFont font(int column) • QBrush foreground(int column) • QIcon icon(int column) • int indexOfChild(QTreeWidgetItem *child) • void insertChild(int index, QTreeWidgetItem *child) • bool isDisabled(void) • bool isExpanded(void) • bool isFirstColumnSpanned(void) • bool isHidden(void) • bool isSelected(void) • QTreeWidgetItem *parent(void) • void read(QDataStream) • void removeChild(QTreeWidgetItem *child) • void setBackground(int column,QBrush) • void setCheckState(int column, Qt::CheckState state) • void setChildIndicatorPolicy(QTreeWidgetItem::ChildIndicatorPolicy policy) • void setData(int column, int role,QVariant) • void setDisabled(bool disabled) • void setExpanded(bool expand) • void setFirstColumnSpanned(bool span) • void setFlags(Qt::ItemFlag flags) • void setFont(int column, QFont) 70.22. QTreeWidgetItem Class 695
- 719. Ring Documentation, Release1.4.1 • void setForeground(int column, QBrush) • void setHidden(bool hide) • void setIcon(int column, QIcon) • void setSelected(bool select) • void setSizeHint(int column, QSize) • void setStatusTip(int column, QString) • void setText(int column, QString) • void setTextAlignment(int column, int alignment) • void setToolTip(int column, QString) • void setWhatsThis(int column, QString) • QSize sizeHint(int column) • void sortChildren(int column, Qt::SortOrder order) • QString statusTip(int column) • QTreeWidgetItem *takeChild(int index) • QString text(int column) • int textAlignment(int column) • QString toolTip(int column) • QTreeWidget *treeWidget(void) • int type(void) • QString whatsThis(int column) • void write(QDataStream) 70.23 QComboBox Class C++ Reference : http://doc.qt.io/qt-5/QComboBox.html Parameters : QWidget * Parent Class : QWidget • void addItem(QString,int) • QCompleter *completer(void) • int count(void) • int currentIndex(void) • QString currentText(void) • bool duplicatesEnabled(void) • int findData(QVariant, int role, Qt::MatchFlag flags) • int findText(QString, Qt::MatchFlag flags) • bool hasFrame(void) 70.23. QComboBox Class 696
- 720. Ring Documentation, Release1.4.1 • void hidePopup(void) • QSize iconSize(void) • void insertItem(int index, QString, QVariant) • bool isEditable(void) • QVariant itemData(int index, int role) • QAbstractItemDelegate *itemDelegate(void) • QIcon itemIcon(int index) • QString itemText(int index) • QLineEdit *lineEdit(void) • int maxCount(void) • int maxVisibleItems(void) • int minimumContentsLength(void) • QAbstractItemModel *model(void) • int modelColumn(void) • void removeItem(int index) • QModelIndex rootModelIndex(void) • void setCompleter(QCompleter *completer) • void setDuplicatesEnabled(bool enable) • void setEditable(bool editable) • void setFrame(bool) • void setIconSize(QSize) • void setItemDelegate(QAbstractItemDelegate *delegate) • void setItemIcon(int index, QIcon) • void setItemText(int index, QString) • void setLineEdit(QLineEdit *edit) • void setMaxCount(int max) • void setMaxVisibleItems(int maxItems) • void setMinimumContentsLength(int characters) • void setModel(QAbstractItemModel *model) • void setModelColumn(int visibleColumn) • void setRootModelIndex(QModelIndex) • void setView(QAbstractItemView *itemView) • void showPopup(void) • QAbstractItemView *view(void) • void clear(void) • void clearEditText(void) 70.23. QComboBox Class 697
- 721. Ring Documentation, Release1.4.1 • void setCurrentIndex(int index) • void setEditText(QString) • void setactivatedEvent(const char *) • void setcurrentIndexChangedEvent(const char *) • void seteditTextChangedEvent(const char *) • void sethighlightedEvent(const char *) • const char *getactivatedEvent(void) • const char *getcurrentIndexChangedEvent(void) • const char *geteditTextChangedEvent(void) • const char *gethighlightedEvent(void) 70.24 QMenuBar Class C++ Reference : http://doc.qt.io/qt-5/QMenuBar.html Parameters : QWidget * Parent Class : QWidget • QAction *actionAt(QPoint) • QRect actionGeometry(QAction *act) • QAction *activeAction(void) • QAction *addAction(QString) • QAction *addSeparator(void) • void clear(void) • QWidget *cornerWidget(Qt::Corner) • QAction *insertSeparator(QAction *before) • bool isDefaultUp(void) • bool isNativeMenuBar(void) • void setActiveAction(QAction *act) • void setCornerWidget(QWidget *widget, Qt::Corner) • void setNativeMenuBar(bool nativeMenuBar) 70.25 QMenu Class C++ Reference : http://doc.qt.io/qt-5/QMenu.html Parameters : QWidget * Parent Class : QWidget • QAction *actionAt(QPoint) • QRect actionGeometry(QAction *act) 70.24. QMenuBar Class 698
- 722. Ring Documentation, Release1.4.1 • QAction *activeAction(void) • void addAction(QAction *) • QMenu *addMenu(QString) • QAction *addSeparator(void) • void clear(void) • QAction *defaultAction(void) • QAction *exec(void) • void hideTearOffMenu(void) • QIcon icon(void) • QAction *insertMenu(QAction *before, QMenu *menu) • QAction *insertSeparator(QAction *before) • bool isEmpty(void) • bool isTearOffEnabled(void) • bool isTearOffMenuVisible(void) • QAction *menuAction(void) • void popup(QPoint, QAction *atAction) • bool separatorsCollapsible(void) • void setActiveAction(QAction *act) • void setDefaultAction(QAction *act) • void setIcon(QIcon) • void setSeparatorsCollapsible(bool collapse) • void setTearOffEnabled(bool) • void setTitle(QString) • QString title(void) 70.26 QToolBar Class C++ Reference : http://doc.qt.io/qt-5/QToolBar.html Parameters : QWidget * Parent Class : QWidget • QAction *actionAt(int x, int y) • QAction *addAction(QString) • QAction *addSeparator(void) • QAction *addWidget(QWidget *widget) • int allowedAreas(void) • void clear(void) 70.26. QToolBar Class 699
- 723. Ring Documentation, Release1.4.1 • QSize iconSize(void) • QAction *insertSeparator(QAction *before) • QAction *insertWidget(QAction *before, QWidget *widget) • bool isAreaAllowed(Qt::ToolBarArea area) • bool isFloatable(void) • bool isFloating(void) • bool isMovable(void) • int orientation(void) • void setAllowedAreas(Qt::ToolBarArea areas) • void setFloatable(bool floatable) • void setMovable(bool movable) • void setOrientation(Qt::Orientation orientation) • QAction *toggleViewAction(void) • int toolButtonStyle(void) • QWidget *widgetForAction(QAction *action) • void setIconSize(QSize) • void setToolButtonStyle(Qt::ToolButtonStyle toolButtonStyle) 70.27 QMainWindow Class C++ Reference : http://doc.qt.io/qt-5/QMainWindow.html Parameters : void Parent Class : QWidget • void addDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget, Qt::Orientation orientation) • QToolBar *addToolBar(QString) • void addToolBar_2(Qt::ToolBarArea area, QToolBar *toolbar) • void addToolBarBreak(Qt::ToolBarArea) • QWidget *centralWidget(void) • int corner(Qt::Corner corner) • QMenu *createPopupMenu(void) • int dockOptions(void) • int dockWidgetArea(QDockWidget *dockwidget) • bool documentMode(void) • QSize iconSize(void) • void insertToolBar(QToolBar *before, QToolBar *toolbar) • void insertToolBarBreak(QToolBar *before) 70.27. QMainWindow Class 700
- 724. Ring Documentation, Release1.4.1 • bool isAnimated(void) • bool isDockNestingEnabled(void) • QMenuBar *menuBar(void) • QWidget *menuWidget(void) • void removeDockWidget(QDockWidget *dockwidget) • void removeToolBar(QToolBar *toolbar) • void removeToolBarBreak(QToolBar *before) • bool restoreDockWidget(QDockWidget *dockwidget) • bool restoreState(QByteArray state, int version) • QByteArray saveState(int version) • void setCentralWidget(QWidget *widget) • void setCorner(Qt::Corner corner, Qt::DockWidgetArea area) • void setDockOptions(QMainWindow::DockOption options) • void setDocumentMode(bool enabled) • void setIconSize(QSize) • void setMenuBar(QMenuBar *menuBar) • void setMenuWidget(QWidget *menuBar) • void setStatusBar(QStatusBar *statusbar) • void setTabPosition(Qt::DockWidgetArea areas, QTabWidget::TabPosition tabPosition) • void setTabShape(QTabWidget::TabShape tabShape) • void setToolButtonStyle(Qt::ToolButtonStyle toolButtonStyle) • void setUnifiedTitleAndToolBarOnMac(bool set) • void splitDockWidget(QDockWidget *first, QDockWidget *second, Qt::Orientation orientation) • QStatusBar *statusBar(void) • int tabPosition(Qt::DockWidgetArea area) • int tabShape(void) • void tabifyDockWidget(QDockWidget *first, QDockWidget *second) • int toolBarArea(QToolBar *toolbar) • bool toolBarBreak(QToolBar *toolbar) • int toolButtonStyle(void) • bool unifiedTitleAndToolBarOnMac(void) 70.28 QStatusBar Class C++ Reference : http://doc.qt.io/qt-5/QStatusBar.html Parameters : QWidget * 70.28. QStatusBar Class 701
- 725. Ring Documentation, Release1.4.1 Parent Class : QWidget • void addPermanentWidget(QWidget * widget, int stretch) • void addWidget(QWidget * widget, int stretch) • QString currentMessage(void) • int insertPermanentWidget(int index, QWidget * widget, int stretch) • int insertWidget(int index, QWidget * widget, int stretch) • bool isSizeGripEnabled(void) • void removeWidget(QWidget *widget) • void setSizeGripEnabled(bool) • void clearMessage(void) • void showMessage(QString , int timeout) 70.29 QDockWidget Class C++ Reference : http://doc.qt.io/qt-5/QDockWidget.html Parameters : QWidget *parent,Qt::WindowType flag Parent Class : QWidget • int allowedAreas(void) • int features(void) • bool isAreaAllowed(Qt::DockWidgetArea area) • bool isFloating(void) • void setAllowedAreas(Qt::DockWidgetArea areas) • void setFeatures(QDockWidget::DockWidgetFeature features) • void setFloating(bool floating) • void setTitleBarWidget(QWidget *widget) • void setWidget(QWidget *widget) • QWidget *titleBarWidget(void) • QAction *toggleViewAction(void) • QWidget *widget(void) • void allowedAreasChanged(Qt::DockWidgetArea allowedAreas) • void dockLocationChanged(Qt::DockWidgetArea area) • void featuresChanged(QDockWidget::DockWidgetFeature features) • void topLevelChanged(bool topLevel) • void visibilityChanged(bool visible) 70.29. QDockWidget Class 702
- 726. Ring Documentation, Release1.4.1 70.30 QTabWidget Class C++ Reference : http://doc.qt.io/qt-5/QTabWidget.html Parameters : QWidget *parent Parent Class : QWidget • int addTab(QWidget *page, QString) • void clear(void) • QWidget *cornerWidget(Qt::Corner corner) • int count(void) • int currentIndex(void) • QWidget *currentWidget(void) • bool documentMode(void) • int elideMode(void) • QSize iconSize(void) • int indexOf(QWidget *w) • int insertTab(int index, QWidget *page,QString) • bool isMovable(void) • bool isTabEnabled(int index) • void removeTab(int index) • void setCornerWidget(QWidget *widget, Qt::Corner corner) • void setDocumentMode(bool set) • void setElideMode(Qt::TextElideMode) • void setIconSize(QSize) • void setMovable(bool movable) • void setTabEnabled(int index, bool enable) • void setTabIcon(int index, QIcon) • void setTabText(int index,QString) • void setTabToolTip(int index, QString) • void setTabWhatsThis(int index, QString) • void setTabsClosable(bool closeable) • void setUsesScrollButtons(bool useButtons) • QIcon tabIcon(int index) • QString tabText(int index) • QString tabToolTip(int index) • QString tabWhatsThis(int index) • bool tabsClosable(void) 70.30. QTabWidget Class 703
- 727. Ring Documentation, Release1.4.1 • bool usesScrollButtons(void) • QWidget *widget(int index) • int heightForWidth(int width) • QSize minimumSizeHint(void) • QSize sizeHint(void) • void setCurrentIndex(int index) • void setCurrentWidget(QWidget *widget) • void setcurrentChangedEvent(const char *) • void settabCloseRequestedEvent(const char *) • const char *getcurrentChangedEvent(void) • const char *gettabCloseRequestedEvent(void) 70.31 QTableWidgetItem Class C++ Reference : http://doc.qt.io/qt-5/QTableWidgetItem.html Parameters : QString • QBrush background(void) • int checkState(void) • QTableWidgetItem *clone(void) • int column(void) • QVariant data(int role) • int flags(void) • QFont font(void) • QBrush foreground(void) • QIcon icon(void) • bool isSelected(void) • void read(QDataStream) • int row(void) • void setBackground(QBrush) • void setCheckState(Qt::CheckState state) • void setData(int role, QVariant) • void setFlags(Qt::ItemFlag flags) • void setFont(QFont) • void setForeground(QBrush) • void setIcon(QIcon) • void setSelected(bool select) 70.31. QTableWidgetItem Class 704
- 728. Ring Documentation, Release1.4.1 • void setSizeHint(QSize) • void setStatusTip(QString) • void setText(QString) • void setTextAlignment(int alignment) • void setToolTip(QString) • void setWhatsThis(QString) • QSize sizeHint(void) • QString statusTip(void) • QTableWidget *tableWidget(void) • QString text(void) • int textAlignment(void) • QString toolTip(void) • int type(void) • QString whatsThis(void) • void write(QDataStream) 70.32 QFrame Class C++ Reference : http://doc.qt.io/qt-5/QFrame.html Parameters : QWidget *parent, Qt::WindowType flag Parent Class : QWidget • int frameShadow(void) • int frameShape(void) • int frameStyle(void) • int frameWidth(void) • int lineWidth(void) • int midLineWidth(void) • void setFrameRect(QRect) • void setFrameShadow(QFrame::Shadow) • void setFrameShape(QFrame::Shape) • void setFrameStyle(int style) • void setLineWidth(int) • void setMidLineWidth(int) • QSize sizeHint(void) 70.32. QFrame Class 705
- 729. Ring Documentation, Release1.4.1 70.33 QFrame2 Class C++ Reference : http://doc.qt.io/qt-5/QFrame2.html Parameters : void Parent Class : QFrame 70.34 QFrame3 Class C++ Reference : http://doc.qt.io/qt-5/QFrame3.html Parameters : QWidget *parent Parent Class : QFrame 70.35 QAbstractScrollArea Class C++ Reference : http://doc.qt.io/qt-5/QAbstractScrollArea.html Parameters : QWidget *parent Parent Class : QFrame • QWidget *cornerWidget(void) • QScrollBar *horizontalScrollBar(void) • int horizontalScrollBarPolicy(void) • QSize maximumViewportSize(void) • QWidgetList scrollBarWidgets(Qt::AlignmentFlag) • void setCornerWidget(QWidget *widget) • void setHorizontalScrollBar(QScrollBar *scrollBar) • void setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy) • void setVerticalScrollBar(QScrollBar *scrollBar) • void setVerticalScrollBarPolicy(Qt::ScrollBarPolicy) • void setViewport(QWidget *widget) • QScrollBar *verticalScrollBar(void) • int verticalScrollBarPolicy(void) • QWidget *viewport(void) 70.36 QAbstractItemView Class C++ Reference : http://doc.qt.io/qt-5/QAbstractItemView.html Parameters : QWidget *parent Parent Class : QAbstractScrollArea 70.33. QFrame2 Class 706
- 730. Ring Documentation, Release1.4.1 • bool alternatingRowColors(void) • int autoScrollMargin(void) • void closePersistentEditor(QModelIndex) • QModelIndex currentIndex(void) • int defaultDropAction(void) • int dragDropMode(void) • bool dragDropOverwriteMode(void) • bool dragEnabled(void) • int editTriggers(void) • bool hasAutoScroll(void) • int horizontalScrollMode(void) • QSize iconSize(void) • QModelIndex indexAt(QPoint) • QWidget *indexWidget(QModelIndex) • QAbstractItemDelegate *itemDelegate(QModelIndex) • QAbstractItemDelegate *itemDelegateForColumn(int column) • QAbstractItemDelegate *itemDelegateForRow(int row) • void keyboardSearch(QString) • QAbstractItemModel *model(void) • void openPersistentEditor(QModelIndex) • QModelIndex rootIndex(void) • void scrollTo(QModelIndex,QAbstractItemView::ScrollHint) • int selectionBehavior(void) • int selectionMode(void) • QItemSelectionModel *selectionModel(void) • void setAlternatingRowColors(bool enable) • void setAutoScroll(bool enable) • void setAutoScrollMargin(int margin) • void setDefaultDropAction(Qt::DropAction dropAction) • void setDragDropMode(QAbstractItemView::DragDropMode behavior) • void setDragDropOverwriteMode(bool overwrite) • void setDragEnabled(bool enable) • void setDropIndicatorShown(bool enable) • void setEditTriggers(QAbstractItemView::EditTrigger triggers) • void setHorizontalScrollMode(QAbstractItemView::ScrollMode mode) • void setIconSize(QSize) 70.36. QAbstractItemView Class 707
- 731. Ring Documentation, Release1.4.1 • void setIndexWidget(QModelIndex, QWidget *widget) • void setItemDelegate(QAbstractItemDelegate *delegate) • void setItemDelegateForColumn(int column, QAbstractItemDelegate *delegate) • void setItemDelegateForRow(int row, QAbstractItemDelegate *delegate) • void setModel(QAbstractItemModel *model) • void setSelectionBehavior(QAbstractItemView::SelectionBehavior behavior) • void setSelectionMode(QAbstractItemView::SelectionMode mode) • void setSelectionModel(QItemSelectionModel *selectionModel) • void setTabKeyNavigation(bool enable) • void setTextElideMode(Qt::TextElideMode mode) • void setVerticalScrollMode(QAbstractItemView::ScrollMode mode) • bool showDropIndicator(void) • int sizeHintForColumn(int column) • QSize sizeHintForIndex(QModelIndex) • int sizeHintForRow(int row) • bool tabKeyNavigation(void) • int textElideMode(void) • int verticalScrollMode(void) • QRect visualRect(QModelIndex) • void clearSelection(void) • void edit(QModelIndex) • void scrollToBottom(void) • void scrollToTop(void) • void setCurrentIndex(QModelIndex) • void update(QModelIndex) 70.37 QTableView Class C++ Reference : http://doc.qt.io/qt-5/QTableView.html Parameters : QWidget *parent Parent Class : QAbstractItemView • void clearSpans(void) • int columnAt(int x) • int columnSpan(int row, int column) • int columnViewportPosition(int column) • int columnWidth(int column) 70.37. QTableView Class 708
- 732. Ring Documentation, Release1.4.1 • Qt::PenStyle gridStyle(void) • QHeaderView *horizontalHeader(void) • bool isColumnHidden(int column) • bool isCornerButtonEnabled(void) • bool isRowHidden(int row) • bool isSortingEnabled(void) • int rowAt(int y) • int rowHeight(int row) • int rowSpan(int row, int column) • int rowViewportPosition(int row) • void setColumnHidden(int column, bool hide) • void setColumnWidth(int column, int width) • void setCornerButtonEnabled(bool enable) • void setGridStyle(Qt::PenStyle style) • void setHorizontalHeader(QHeaderView *header) • void setRowHeight(int row, int height) • void setRowHidden(int row, bool hide) • void setSortingEnabled(bool enable) • void setSpan(int row, int column, int rowSpanCount, int columnSpanCount) • void setVerticalHeader(QHeaderView *header) • void setWordWrap(bool on) • bool showGrid(void) • void sortByColumn(int column, Qt::SortOrder order) • QHeaderView *verticalHeader(void) • bool wordWrap(void) • void hideColumn(int column) • void hideRow(int row) • void resizeColumnToContents(int column) • void resizeColumnsToContents(void) • void resizeRowToContents(int row) • void resizeRowsToContents(void) • void selectColumn(int column) • void selectRow(int row) • void setShowGrid(bool show) • void showColumn(int column) • void showRow(int row) 70.37. QTableView Class 709
- 733. Ring Documentation, Release1.4.1 70.38 QTableWidget Class C++ Reference : http://doc.qt.io/qt-5/QTableWidget.html Parameters : QWidget *parent Parent Class : QTableView • QWidget *cellWidget(int row, int column) • void closePersistentEditor(QTableWidgetItem *item) • int column(QTableWidgetItem *item) • int columnCount(void) • int currentColumn(void) • QTableWidgetItem *currentItem(void) • int currentRow(void) • void editItem(QTableWidgetItem *item) • QTableWidgetItem *horizontalHeaderItem(int column) • QTableWidgetItem *item(int row, int column) • QTableWidgetItem *itemAt(int ax, int ay) • QTableWidgetItem *itemPrototype(void) • void openPersistentEditor(QTableWidgetItem *item) • void removeCellWidget(int row, int column) • int row(const QTableWidgetItem *item) • int rowCount(void) • QList<QTableWidgetItem *> selectedItems(void) • QList<QTableWidgetSelectionRange> selectedRanges(void) • void setCellWidget(int row, int column, QWidget *widget) • void setColumnCount(int columns) • void setCurrentCell(int row, int column) • void setCurrentItem(QTableWidgetItem * item) • void setHorizontalHeaderItem(int column, QTableWidgetItem *item) • void setHorizontalHeaderLabels(QStringList) • void setItem(int row, int column, QTableWidgetItem *item) • void setItemPrototype(QTableWidgetItem *item) • void setRowCount(int rows) • void setVerticalHeaderItem(int row, QTableWidgetItem *item) • void sortItems(int column, Qt::SortOrder order) • QTableWidgetItem *takeHorizontalHeaderItem(int column) • QTableWidgetItem *takeItem(int row, int column) 70.38. QTableWidget Class 710
- 734. Ring Documentation, Release1.4.1 • QTableWidgetItem *takeVerticalHeaderItem(int row) • QTableWidgetItem *verticalHeaderItem(int row) • int visualColumn(int logicalColumn) • QRect visualItemRect(QTableWidgetItem *) • int visualRow(int logicalRow) • void clear(void) • void clearContents(void) • void insertColumn(int column) • void insertRow(int row) • void removeColumn(int column) • void removeRow(int row) • void scrollToItem(QTableWidgetItem *item, QAbstractItemView::ScrollHint hint) • void setcellActivatedEvent(const char *) • void setcellChangedEvent(const char *) • void setcellClickedEvent(const char *) • void setcellDoubleClickedEvent(const char *) • void setcellEnteredEvent(const char *) • void setcellPressedEvent(const char *) • void setcurrentCellChangedEvent(const char *) • void setcurrentItemChangedEvent(const char *) • void setitemActivatedEvent(const char *) • void setitemChangedEvent(const char *) • void setitemClickedEvent(const char *) • void setitemDoubleClickedEvent(const char *) • void setitemEnteredEvent(const char *) • void setitemPressedEvent(const char *) • void setitemSelectionChangedEvent(const char *) • const char *getcellActivatedEvent(void) • const char *getcellChangedEvent(void) • const char *getcellClickedEvent(void) • const char *getcellDoubleClickedEvent(void) • const char *getcellEnteredEvent(void) • const char *getcellPressedEvent(void) • const char *getcurrentCellChangedEvent(void) • const char *getcurrentItemChangedEvent(void) • const char *getitemActivatedEvent(void) 70.38. QTableWidget Class 711
- 735. Ring Documentation, Release1.4.1 • const char *getitemChangedEvent(void) • const char *getitemClickedEvent(void) • const char *getitemDoubleClickedEvent(void) • const char *getitemEnteredEvent(void) • const char *getitemPressedEvent(void) • const char *getitemSelectionChangedEvent(void) 70.39 QProgressBar Class C++ Reference : http://doc.qt.io/qt-5/QProgressBar.html Parameters : QWidget *parent Parent Class : QWidget • int alignment(void) • QString format(void) • bool invertedAppearance(void) • bool isTextVisible(void) • int maximum(void) • int minimum(void) • int orientation(void) • void resetFormat(void) • void setAlignment(Qt::AlignmentFlag alignment) • void setFormat(QString) • void setInvertedAppearance(bool invert) • void setTextDirection(QProgressBar::Direction textDirection) • void setTextVisible(bool visible) • QString text(void) • int textDirection(void) • int value(void) • void reset(void) • void setMaximum(int maximum) • void setMinimum(int minimum) • void setOrientation(Qt::Orientation) • void setRange(int minimum, int maximum) • void setValue(int value) • void setvalueChangedEvent(const char *) • const char *getvalueChangedEvent(void) 70.39. QProgressBar Class 712
- 736. Ring Documentation, Release1.4.1 70.40 QSpinBox Class C++ Reference : http://doc.qt.io/qt-5/QSpinBox.html Parameters : QWidget *parent Parent Class : QWidget • QString cleanText(void) • int displayIntegerBase(void) • int maximum(void) • int minimum(void) • QString prefix(void) • void setDisplayIntegerBase(int base) • void setMaximum(int max) • void setMinimum(int min) • void setPrefix(QString) • void setRange(int minimum, int maximum) • void setSingleStep(int val) • void setSuffix(QString) • int singleStep(void) • QString suffix(void) • int value(void) • void setValue(int val) • void setvalueChangedEvent(const char *) • const char *getvalueChangedEvent(void) 70.41 QAbstractSlider Class C++ Reference : http://doc.qt.io/qt-5/QAbstractSlider.html Parameters : QWidget *parent Parent Class : QWidget • bool invertedAppearance(void) • bool invertedControls(void) • bool isSliderDown(void) • int maximum(void) • int minimum(void) • int orientation(void) • int pageStep(void) • void setInvertedAppearance(bool) 70.40. QSpinBox Class 713
- 737. Ring Documentation, Release1.4.1 • void setInvertedControls(bool) • void setMaximum(int) • void setMinimum(int) • void setPageStep(int) • void setSingleStep(int) • void setSliderDown(bool) • void setSliderPosition(int) • void setTracking(bool enable) • int singleStep(void) • int sliderPosition(void) • void triggerAction(QAbstractSlider::SliderAction action) • int value(void) • void setOrientation(Qt::Orientation) • void setRange(int min, int max) • void setValue(int) 70.42 QSlider Class C++ Reference : http://doc.qt.io/qt-5/QSlider.html Parameters : QWidget *parent Parent Class : QAbstractSlider • void setTickInterval(int ti) • void setTickPosition(QSlider::TickPosition position) • int tickInterval(void) • int tickPosition(void) • QSize minimumSizeHint(void) • QSize sizeHint(void) • void setactionTriggeredEvent(const char *) • void setrangeChangedEvent(const char *) • void setsliderMovedEvent(const char *) • void setsliderPressedEvent(const char *) • void setsliderReleasedEvent(const char *) • void setvalueChangedEvent(const char *) • const char *getactionTriggeredEvent(void) • const char *getrangeChangedEvent(void) • const char *getsliderMovedEvent(void) 70.42. QSlider Class 714
- 738. Ring Documentation, Release1.4.1 • const char *getsliderPressedEvent(void) • const char *getsliderReleasedEvent(void) • const char *getvalueChangedEvent(void) 70.43 QDateEdit Class C++ Reference : http://doc.qt.io/qt-5/QDateEdit.html Parameters : QWidget *parent Parent Class : QDateTimeEdit 70.44 QDateTimeEdit Class C++ Reference : http://doc.qt.io/qt-5/QDateTimeEdit.html Parameters : QWidget *parent Parent Class : QAbstractSpinBox • bool calendarPopup(void) • QCalendarWidget *calendarWidget(void) • void clearMaximumDate(void) • void clearMaximumDateTime(void) • void clearMaximumTime(void) • void clearMinimumDate(void) • void clearMinimumDateTime(void) • void clearMinimumTime(void) • int currentSection(void) • int currentSectionIndex(void) • QDate date(void) • QDateTime dateTime(void) • QString displayFormat(void) • int displayedSections(void) • QDate maximumDate(void) • QDateTime maximumDateTime(void) • QTime maximumTime(void) • QDate minimumDate(void) • QDateTime minimumDateTime(void) • QTime minimumTime(void) • int sectionAt(int index) • int sectionCount(void) 70.43. QDateEdit Class 715
- 739. Ring Documentation, Release1.4.1 • QString sectionText(QDateTimeEdit::Section section) • void setCalendarPopup(bool enable) • void setCalendarWidget(QCalendarWidget *calendarWidget) • void setCurrentSection(QDateTimeEdit::Section section) • void setCurrentSectionIndex(int index) • void setDateRange(QDate,QDate) • void setDateTimeRange(QDateTime,QDateTime) • void setDisplayFormat(QString) • void setMaximumDate(QDate) • void setMaximumDateTime(QDateTime) • void setMaximumTime(QTime) • void setMinimumDate(QDate) • void setMinimumDateTime(QDateTime) • void setMinimumTime(QTime) • void setSelectedSection(QDateTimeEdit::Section section) • void setTimeRange(QTime,QTime) • void setTimeSpec(Qt::TimeSpec spec) • QTime time(void) • Qt::TimeSpec timeSpec(void) • void setDate(QDate) • void setDateTime(QDateTime) • void setTime(QTime) 70.45 QAbstractSpinBox Class C++ Reference : http://doc.qt.io/qt-5/QAbstractSpinBox.html Parameters : QWidget *parent Parent Class : QWidget • int alignment(void) • int buttonSymbols(void) • int correctionMode(void) • bool hasAcceptableInput(void) • bool hasFrame(void) • void interpretText(void) • bool isAccelerated(void) • bool keyboardTracking(void) 70.45. QAbstractSpinBox Class 716
- 740. Ring Documentation, Release1.4.1 • void setAccelerated(bool on) • void setAlignment(Qt::AlignmentFlag flag) • void setButtonSymbols(QAbstractSpinBox::ButtonSymbols bs) • void setCorrectionMode(QAbstractSpinBox::CorrectionMode cm) • void setFrame(bool) • void setReadOnly(bool r) • void setSpecialValueText(QString) • void setWrapping(bool w) • QString specialValueText(void) • void stepBy(int steps) • QString text(void) • bool wrapping(void) • void clear(void) • void selectAll(void) • void stepDown(void) • void stepUp(void) 70.46 QDial Class C++ Reference : http://doc.qt.io/qt-5/QDial.html Parameters : QWidget *parent Parent Class : QAbstractSlider • int notchSize(void) • qreal notchTarget(void) • bool notchesVisible(void) • void setNotchTarget(double target) • bool wrapping(void) • QSize minimumSizeHint(void) • QSize sizeHint(void) • void setNotchesVisible(bool visible) • void setWrapping(bool on) • void setactionTriggeredEvent(const char *) • void setrangeChangedEvent(const char *) • void setsliderMovedEvent(const char *) • void setsliderPressedEvent(const char *) • void setsliderReleasedEvent(const char *) 70.46. QDial Class 717
- 741. Ring Documentation, Release1.4.1 • void setvalueChangedEvent(const char *) • const char *getactionTriggeredEvent(void) • const char *getrangeChangedEvent(void) • const char *getsliderMovedEvent(void) • const char *getsliderPressedEvent(void) • const char *getsliderReleasedEvent(void) • const char *getvalueChangedEvent(void) 70.47 QWebView Class C++ Reference : http://doc.qt.io/archives/qt-5.5/qwebview.html Parameters : QWidget *parent Parent Class : QWidget • QWebHistory *history(void) • QAction *pageAction(QWebPage::WebAction action) • void setContent(QByteArray,QString,QUrl) • void setHtml(QString,QUrl) • void setPage(QWebPage *page) • void setZoomFactor(qreal factor) • QWebSettings *settings(void) • void triggerPageAction(QWebPage::WebAction action, bool checked) • QUrl url(void) • qreal zoomFactor(void) • void back(void) • void forward(void) • void print(QPrinter *printer) • void reload(void) • void stop(void) • void setloadProgressEvent(const char *) • void setloadStartedEvent(const char *) • void setselectionChangedEvent(const char *) • void seturlChangedEvent(const char *) • const char *getloadFinishedEvent(void) • const char *getloadProgressEvent(void) • const char *getloadStartedEvent(void) • const char *getselectionChangedEvent(void) 70.47. QWebView Class 718
- 742. Ring Documentation, Release1.4.1 • const char *gettitleChangedEvent(void) • const char *geturlChangedEvent(void) 70.48 QUrl Class C++ Reference : http://doc.qt.io/qt-5/QUrl.html Parameters : QString • void clear(void) • QString errorString(void) • QString fileName(QUrl::ComponentFormattingOption options) • QString fragment(QUrl::ComponentFormattingOption options) • bool hasFragment(void) • bool hasQuery(void) • QString host(QUrl::ComponentFormattingOption options) • bool isEmpty(void) • bool isLocalFile(void) • bool isParentOf(QUrl) • bool isRelative(void) • bool isValid(void) • QString path(QUrl::ComponentFormattingOption options) • int port(int defaultPort) • QString query(QUrl::ComponentFormattingOption options) • QUrl resolved(QUrl) • QString scheme(void) • void setAuthority(QString, QUrl::ParsingMode mode) • void setFragment(QString, QUrl::ParsingMode mode) • void setHost(QString, QUrl::ParsingMode mode) • void setPassword(QString, QUrl::ParsingMode mode) • void setPath(QString, QUrl::ParsingMode mode) • void setPort(int port) • void setQuery(QString, QUrl::ParsingMode mode) • void setScheme(QString) • void setUrl(QString, QUrl::ParsingMode parsingMode) • void setUserInfo(QString, QUrl::ParsingMode mode) • void setUserName(QString, QUrl::ParsingMode mode) • void swap(QUrl) 70.48. QUrl Class 719
- 743. Ring Documentation, Release1.4.1 • QString topLevelDomain(QUrl::ComponentFormattingOption options) • QString userInfo(QUrl::ComponentFormattingOption options) • QString userName(QUrl::ComponentFormattingOption options) • QUrl fromLocalFile(QString) 70.49 QCheckBox Class C++ Reference : http://doc.qt.io/qt-5/QCheckBox.html Parameters : QWidget *parent Parent Class : QAbstractButton • int checkState(void) • bool isTristate(void) • void setCheckState(Qt::CheckState state) • void setTristate(bool y) • QSize minimumSizeHint(void) • QSize sizeHint(void) • void setstateChangedEvent(const char *) • void setclickedEvent(const char *) • void setpressedEvent(const char *) • void setreleasedEvent(const char *) • void settoggledEvent(const char *) • const char *getstateChangedEvent(void) • const char *getclickedEvent(void) • const char *getpressedEvent(void) • const char *getreleasedEvent(void) • const char *gettoggledEvent(void) 70.50 QAbstractButton Class C++ Reference : http://doc.qt.io/qt-5/QAbstractButton.html Parameters : QWidget *parent Parent Class : QWidget • bool autoExclusive(void) • bool autoRepeat(void) • int autoRepeatDelay(void) • int autoRepeatInterval(void) • QButtonGroup *group(void) 70.49. QCheckBox Class 720
- 744. Ring Documentation, Release1.4.1 • QIcon icon(void) • QSize iconSize(void) • bool isCheckable(void) • bool isChecked(void) • bool isDown(void) • void setAutoExclusive(bool) • void setAutoRepeat(bool) • void setAutoRepeatDelay(int) • void setAutoRepeatInterval(int) • void setCheckable(bool) • void setDown(bool) • void setIcon(QIcon) • void setShortcut(QKeySequence) • void setText(QString) • QKeySequence shortcut(void) • QString text(void) • void animateClick(int msec) • void click(void) • void setChecked(bool) • void setIconSize(QSize) • void toggle(void) 70.51 QRadioButton Class C++ Reference : http://doc.qt.io/qt-5/QRadioButton.html Parameters : QWidget *parent Parent Class : QAbstractButton • QSize minimumSizeHint(void) • QSize sizeHint(void) • void setclickedEvent(const char *) • void setpressedEvent(const char *) • void setreleasedEvent(const char *) • void settoggledEvent(const char *) • const char *getclickedEvent(void) • const char *getpressedEvent(void) • const char *getreleasedEvent(void) 70.51. QRadioButton Class 721
- 745. Ring Documentation, Release1.4.1 • const char *gettoggledEvent(void) 70.52 QButtonGroup Class C++ Reference : http://doc.qt.io/qt-5/QButtonGroup.html Parameters : QObject *parent • void addButton(QAbstractButton *button, int id) • QAbstractButton *button(int id) • QAbstractButton *checkedButton(void) • int checkedId(void) • bool exclusive(void) • int id(QAbstractButton *button) • void removeButton(QAbstractButton *button) • void setExclusive(bool) • void setId(QAbstractButton *button, int id) • void setbuttonClickedEvent(const char *) • void setbuttonPressedEvent(const char *) • void setbuttonReleasedEvent(const char *) • const char *getbuttonClickedEvent(void) • const char *getbuttonPressedEvent(void) • const char *getbuttonReleasedEvent(void) 70.53 QMediaPlayer Class C++ Reference : http://doc.qt.io/qt-5/QMediaPlayer.html Parameters : void • int bufferStatus(void) • QMediaContent currentMedia(void) • QNetworkConfiguration currentNetworkConfiguration(void) • int duration(void) • int error(void) • QString errorString(void) • bool isAudioAvailable(void) • bool isMuted(void) • bool isSeekable(void) • bool isVideoAvailable(void) • QMediaContent media(void) 70.52. QButtonGroup Class 722
- 746. Ring Documentation, Release1.4.1 • int mediaStatus(void) • QIODevice *mediaStream(void) • qreal playbackRate(void) • QMediaPlaylist *playlist(void) • int position(void) • void setVideoOutput(QVideoWidget *output) • int volume(void) • void pause(void) • void play(void) • void setMuted(bool muted) • void setPlaylist(QMediaPlaylist *playlist) • void setPosition(int position) • void setVolume(int volume) • void stop(void) 70.54 QMediaPlaylist Class C++ Reference : http://doc.qt.io/qt-5/QMediaPlaylist.html Parameters : void • int currentIndex(void) • QMediaContent currentMedia(void) • int error(void) • QString errorString(void) • bool insertMedia(int pos, QMediaContent) • bool isReadOnly(void) • QMediaContent media(int index) • int mediaCount(void) • int nextIndex(int steps) • int playbackMode(void) • int previousIndex(int steps) • bool save(QUrl, const char * format) • void next(void) # In RingQt use : void movenext(void) • void previous(void) • void setCurrentIndex(int playlistPosition) • void shuffle(void) 70.54. QMediaPlaylist Class 723
- 747. Ring Documentation, Release1.4.1 70.55 QVideoWidget Class C++ Reference : http://doc.qt.io/qt-5/QVideoWidget.html Parameters : QWidget *parent Parent Class : QWidget • int aspectRatioMode(void) • int brightness(void) • int contrast(void) • int hue(void) • bool isFullScreen(void) • int saturation(void) • void setAspectRatioMode(Qt::AspectRatioMode mode) • void setBrightness(int brightness) • void setContrast(int contrast) • void setFullScreen(bool fullScreen) • void setHue(int hue) • void setSaturation(int saturation) • void setbrightnessChangedEvent(const char *) • void setcontrastChangedEvent(const char *) • void setfullScreenChangedEvent(const char *) • void sethueChangedEvent(const char *) • void setsaturationChangedEvent(const char *) • const char *getbrightnessChangedEvent(void) • const char *getcontrastChangedEvent(void) • const char *getfullScreenChangedEvent(void) • const char *gethueChangedEvent(void) • const char *getsaturationChangedEvent(void) 70.56 QAction Class C++ Reference : http://doc.qt.io/qt-5/QAction.html Parameters : QWidget *parent • QActionGroup *actionGroup(void) • void activate(QAction::ActionEvent event) • bool autoRepeat(void) • QVariant data(void) • QFont font(void) 70.55. QVideoWidget Class 724
- 748. Ring Documentation, Release1.4.1 • QIcon icon(void) • QString iconText(void) • bool isCheckable(void) • bool isChecked(void) • bool isEnabled(void) • bool isIconVisibleInMenu(void) • bool isSeparator(void) • bool isVisible(void) • QMenu *menu(void) • int menuRole(void) • QWidget *parentWidget(void) • int priority(void) • void setActionGroup(QActionGroup *group) • void setAutoRepeat(bool) • void setCheckable(bool) • void setData(QVariant) • void setFont(QFont) • void setIcon(QIcon) • void setIconText(QString) • void setIconVisibleInMenu(bool visible) • void setMenu(QMenu *menu) • void setMenuRole(QAction::MenuRole menuRole) • void setPriority(QAction::Priority priority) • void setSeparator(bool b) • void setShortcut(QKeySequence) • void setShortcutContext(Qt::ShortcutContext context) • void setShortcuts(QKeySequence::StandardKey key) • void setStatusTip(QString) • void setText(QString) • void setToolTip(QString) • void setWhatsThis(QString) • QKeySequence shortcut(void) • int shortcutContext(void) • bool showStatusText(QWidget *widget) • QString statusTip(void) • QString text(void) 70.56. QAction Class 725
- 749. Ring Documentation, Release1.4.1 • QString toolTip(void) • QString whatsThis(void) • void hover(void) • void setChecked(bool) • void setDisabled(bool) • void setEnabled(bool) • void setVisible(bool) • void toggle(void) • void trigger(void) • void setClickEvent(const char *) • const char *getClickEvent(void) 70.57 QEvent Class C++ Reference : http://doc.qt.io/qt-5/QEvent.html Parameters : QEvent::Type Type • void accept(void) • void ignore(void) • bool isAccepted(void) • void setAccepted(bool accepted) • bool spontaneous(void) • int type(void) 70.58 QMessageBox Class C++ Reference : http://doc.qt.io/qt-5/QMessageBox.html Parameters : QWidget *parent Parent Class : QDialog • void addButton(QAbstractButton *button, QMessageBox::ButtonRole role) • QAbstractButton *button(QMessageBox::StandardButton which) • int buttonRole(QAbstractButton *button) • QAbstractButton *clickedButton(void) • QPushButton *defaultButton(void) • QString detailedText(void) • QAbstractButton *escapeButton(void) • QPixmap iconPixmap(void) • QString informativeText(void) 70.57. QEvent Class 726
- 750. Ring Documentation, Release1.4.1 • void open(QObject *receiver, const char *member) • void removeButton(QAbstractButton *button) • void setDefaultButton(QPushButton *button) • void setDetailedText(QString) • void setEscapeButton(QAbstractButton *button) • void setIconPixmap(QPixmap) • void setInformativeText(QString) • void setStandardButtons(QMessageBox::StandardButton buttons) • void setText(QString) • void setTextFormat(Qt::TextFormat format) • void setWindowModality(Qt::WindowModality windowModality) • void setWindowTitle(QString) • int standardButton(QAbstractButton *button) • int standardButtons(void) • QString text(void) • int textFormat(void) • int exec(void) • void about(QWidget *parent, QString,QString) • void aboutQt(QWidget *parent, QString) • int critical(QWidget * parent, QString , QString, int buttons, int defaultButton) • int information(QWidget * parent, QString ,QString, int buttons,int defaultButton) • int question(QWidget * parent,QString,QString, int buttons ,int defaultButton) • int warning(QWidget *parent, QString,QString, int buttons,int defaultButton) 70.59 QTimer Class C++ Reference : http://doc.qt.io/qt-5/QTimer.html Parameters : QObject *parent • int interval(void) • bool isActive(void) • bool isSingleShot(void) • void setInterval(int msec) • void setSingleShot(bool singleShot) • int timerId(void) • void start(void) • void stop(void) 70.59. QTimer Class 727
- 751. Ring Documentation, Release1.4.1 • void settimeoutEvent(const char *) • const char *gettimeoutEvent(void) 70.60 QFileDialog Class C++ Reference : http://doc.qt.io/qt-5/QFileDialog.html Parameters : QWidget *parent Parent Class : QWidget • int acceptMode(void) • QString defaultSuffix(void) • QDir directory(void) • QUrl directoryUrl(void) • int fileMode(void) • int filter(void) • QStringList history(void) • QFileIconProvider *iconProvider(void) • QAbstractItemDelegate *itemDelegate(void) • QString labelText(QFileDialog::DialogLabel label) • QStringList mimeTypeFilters(void) • QStringList nameFilters(void) • void open(QObject *receiver, const char *member) • int options(void) • QAbstractProxyModel *proxyModel(void) • bool restoreState(QByteArray) • QByteArray saveState(void) • void selectFile(QString) • void selectMimeTypeFilter(QString) • void selectNameFilter(QString) • void selectUrl(QUrl) • QStringList selectedFiles(void) • QString selectedNameFilter(void) • void setDefaultSuffix(QString) • void setDirectory(QString) • void setDirectoryUrl(QUrl) • void setFileMode(QFileDialog::FileMode mode) • void setFilter(QDir::Filter filters) 70.60. QFileDialog Class 728
- 752. Ring Documentation, Release1.4.1 • void setHistory(QStringList) • void setIconProvider(QFileIconProvider *provider) • void setItemDelegate(QAbstractItemDelegate *delegate) • void setLabelText(QFileDialog::DialogLabel label, QString) • void setMimeTypeFilters(QStringList) • void setNameFilter(QString) • void setNameFilters(QStringList) • void setOption(QFileDialog::Option option, bool) • void setOptions(QFileDialog::Option options) • void setProxyModel(QAbstractProxyModel *proxyModel) • int viewMode(void) • QString getExistingDirectory(QWidget *,QString,QString, QFileDialog::Option) • QUrl getExistingDirectoryUrl(QWidget *,QString,QUrl, QFileDialog::Option,QStringList) • QString getOpenFileName(QWidget *,QString,QString,QString) • QUrl getSaveFileUrl(QWidget *,QString, QUrl,QString, QString *, QFileDialog::Option options,QStringList) 70.61 QPainter Class C++ Reference : http://doc.qt.io/qt-5/QPainter.html Parameters : void • QBrush background(void) • int backgroundMode(void) • bool begin(QPaintDevice *device) • void beginNativePainting(void) • QRect boundingRect(int x, int y, int w, int h, int flags, QString text) • QBrush brush(void) • QPoint brushOrigin(void) • QRectF clipBoundingRect(void) • QPainterPath clipPath(void) • QRegion clipRegion(void) • QTransform combinedTransform(void) • int compositionMode(void) • QPaintDevice *device(void) • QTransform deviceTransform(void) • void drawArc(int x, int y, int width, int height, int startAngle, int spanAngle) • void drawChord(int x, int y, int width, int height, int startAngle, int spanAngle) 70.61. QPainter Class 729
- 753. Ring Documentation, Release1.4.1 • void drawConvexPolygon( QPoint * points, int pointCount) • void drawEllipse(int x, int y, int width, int height) • void drawGlyphRun( QPointF position, QGlyphRun glyphs) • void drawImage(int x, int y, QImage image) • void drawLine(int x1, int y1, int x2, int y2) • void drawLines( QLine * lines, int lineCount) • void drawPath( QPainterPath path) • void drawPicture(int x, int y, QPicture picture) • void drawPie(int x, int y, int width, int height, int startAngle, int spanAngle) • void drawPixmap(int x, int y, QPixmap) • void drawPoints( QPointF * points, int pointCount) • void drawRect(int x, int y, int width, int height) • void drawRects( QRectF * rectangles, int rectCount) • void drawRoundedRect(int x, int y, int w, int h, qreal xRadius, qreal yRadius, Qt::SizeMode mode) • void drawStaticText(int left, int top, QStaticText staticText) • void drawText(int x, int y, QString text) • void drawTiledPixmap(int x, int y, int width, int height, QPixmap pixmap, int sx, int sy) • bool end(void) # In RingQt use : bool endpaint(void) • void endNativePainting(void) • void eraseRect(int x, int y, int width, int height) • void fillPath( QPainterPath path, QBrush brush) • void fillRect(int x, int y, int width, int height, QBrush) • QFont font(void) • QFontInfo fontInfo(void) • bool hasClipping(void) • void initFrom( QWidget *widget) • bool isActive(void) • int layoutDirection(void) • double opacity(void) • QPaintEngine *paintEngine(void) • QPen pen(void) • int renderHints(void) • void resetTransform(void) • void restore(void) • void rotate(qreal angle) • void save(void) 70.61. QPainter Class 730
- 754. Ring Documentation, Release1.4.1 • void scale(double sx, double sy) • void setBackground( QBrush brush) • void setBackgroundMode(Qt::BGMode mode) • void setBrush(QBrush brush) • void setBrushOrigin(int x, int y) • void setClipPath( QPainterPath path, Qt::ClipOperation operation) • void setClipRect(int x, int y, int width, int height, Qt::ClipOperation operation) • void setClipRegion( QRegion region, Qt::ClipOperation operation) • void setClipping(bool enable) • void setCompositionMode(QPainter::CompositionMode mode) • void setFont( QFont font) • void setLayoutDirection(Qt::LayoutDirection direction) • void setOpacity(qreal opacity) • void setPen(QPen pen) • void setRenderHint(QPainter::RenderHint hint, bool on) • void setTransform( QTransform transform, bool combine) • void setViewTransformEnabled(bool enable) • void setViewport(int x, int y, int width, int height) • void setWindow(int x, int y, int width, int height) • void setWorldMatrixEnabled(bool enable) • void setWorldTransform( QTransform matrix, bool combine) • void shear(double sh, double sv) • void strokePath( QPainterPath path, QPen pen) • bool testRenderHint(QPainter::RenderHint hint) • QTransform transform(void) • void translate(double dx, double dy) • bool viewTransformEnabled(void) • QRect viewport(void) • QRect window(void) • bool worldMatrixEnabled(void) • QTransform worldTransform(void) • void drawPolygon(QPainter *pObject, Qt::FillRule fillRule ) 70.61. QPainter Class 731
- 755. Ring Documentation, Release1.4.1 70.62 QPainter2 Class C++ Reference : http://doc.qt.io/qt-5/QPainter2.html Parameters : QPaintDevice * Parent Class : QPainter 70.63 QPicture Class C++ Reference : http://doc.qt.io/qt-5/QPicture.html Parameters : void • QRect boundingRect(void) • const char *data(void) • bool isNull(void) • bool load(QString, const char *format) # In RingQt use : bool loadfile(QString, const char *format) • bool play(QPainter *painter) • bool save(QString , const char *format) • void setBoundingRect(QRect) • int size(void) • void swap(QPicture) 70.64 QPen Class C++ Reference : http://doc.qt.io/qt-5/QPen.html Parameters : void • QBrush brush(void) • int capStyle(void) • QColor color(void) • double dashOffset(void) • bool isCosmetic(void) • bool isSolid(void) • int joinStyle(void) • double miterLimit(void) • void setBrush(QBrush) • void setCapStyle(Qt::PenCapStyle style) • void setColor(QColor) • void setCosmetic(bool cosmetic) • void setDashOffset(double offset) 70.62. QPainter2 Class 732
- 756. Ring Documentation, Release1.4.1 • void setJoinStyle(Qt::PenJoinStyle style) • void setMiterLimit(double limit) • void setStyle(Qt::PenStyle style) • void setWidth(int width) • void setWidthF(double width) • int style(void) • void swap(QPen) • int width(void) • double widthF(void) 70.65 QColor Class C++ Reference : http://doc.qt.io/qt-5/QColor.html Parameters : void • int alpha(void) • double alphaF(void) • int black(void) • double blackF(void) • int blue(void) • double blueF(void) • QColor convertTo(QColor::Spec colorSpec) • int cyan(void) • double cyanF(void) • QColor darker(int factor) • void getCmyk(int *c, int *m, int *y, int *k, int *a) • void getCmykF(qreal *c, qreal *m, qreal *y, qreal *k, qreal *a) • void getHsl(int *h, int *s, int *l, int *a) • void getHslF(qreal *h, qreal *s, qreal *l, qreal *a) • void getHsv(int *h, int *s, int *v, int *a) • void getHsvF(qreal *h, qreal *s, qreal *v, qreal *a) • void getRgb(int *r, int *g, int *b, int *a) • void getRgbF(qreal *r, qreal *g, qreal *b, qreal *a) • int green(void) • double greenF(void) • int hslHue(void) • double hslHueF(void) 70.65. QColor Class 733
- 757. Ring Documentation, Release1.4.1 • int hslSaturation(void) • double hslSaturationF(void) • int hsvHue(void) • double hsvHueF(void) • int hsvSaturation(void) • double hsvSaturationF(void) • int hue(void) • double hueF(void) • bool isValid(void) • QColor lighter(int factor) • int lightness(void) • double lightnessF(void) • int magenta(void) • double magentaF(void) • QString name(void) • int red(void) • double redF(void) • QRgb rgb(void) • QRgb rgba(void) • int saturation(void) • double saturationF(void) • void setAlpha(int alpha) • void setAlphaF(double alpha) • void setBlue(int blue) • void setBlueF(double blue) • void setCmyk(int c, int m, int y, int k, int a) • void setCmykF(double c, double m, double y, double k, double a) • void setGreen(int green) • void setGreenF(double green) • void setHsl(int h, int s, int l, int a) • void setHslF(double h, double s, double l, double a) • void setHsv(int h, int s, int v, int a) • void setHsvF(double h, double s, double v, double a) • void setNamedColor(QString) • void setRed(int red) • void setRedF(double red) 70.65. QColor Class 734
- 758. Ring Documentation, Release1.4.1 • void setRgb(int r, int g, int b, int a) • void setRgbF(double r, double g, double b, double a) • void setRgba(QRgb rgba) • int spec(void) • QColor toCmyk(void) • QColor toHsl(void) • QColor toHsv(void) • QColor toRgb(void) • int value(void) • double valueF(void) • int yellow(void) • double yellowF(void) • QStringList colorNames(void) • QColor fromCmyk(int c, int m, int y, int k, int a) • QColor fromCmykF(double c, double m, double y, double k, double a) • QColor fromHsl(int h, int s, int l, int a) • QColor fromHslF(double h, double s, double l, double a) • QColor fromHsv(int h, int s, int v, int a) • QColor fromHsvF(double h, double s, double v, double a) • QColor fromRgb(int r, int g, int b, int a) • QColor fromRgbF(double r, double g, double b, double a) • QColor fromRgba(QRgb rgba) • bool isValidColor(QString) 70.66 QPrinter Class C++ Reference : http://doc.qt.io/qt-5/QPrinter.html Parameters : QPrinter::PrinterMode • bool abort(void) • bool collateCopies(void) • int colorMode(void) • int copyCount(void) • QString creator(void) • QString docName(void) • int duplex(void) • bool fontEmbeddingEnabled(void) 70.66. QPrinter Class 735
- 759. Ring Documentation, Release1.4.1 • int fromPage(void) • bool fullPage(void) • bool isValid(void) • QString outputFileName(void) • int outputFormat(void) • QRectF pageRect(QPrinter::Unit unit) • QRectF paperRect(QPrinter::Unit unit) • int paperSource(void) • QPrintEngine *printEngine(void) • QString printProgram(void) • int printRange(void) • QString printerName(void) • QString printerSelectionOption(void) • int printerState(void) • int resolution(void) • void setCollateCopies(bool collate) • void setColorMode(QPrinter::ColorMode newColorMode) • void setCopyCount(int count) • void setCreator(QString) • void setDocName(QString) • void setDuplex(QPrinter::DuplexMode duplex) • void setFontEmbeddingEnabled(bool enable) • void setFromTo(int from, int to) • void setFullPage(bool fp) • void setOutputFileName(QString) • void setOutputFormat(QPrinter::OutputFormat format) • void setPrintProgram(QString) • void setPrintRange(QPrinter::PrintRange) • void setPrinterName(QString) • void setPrinterSelectionOption(QString) • void setResolution(int dpi) • bool supportsMultipleCopies(void) • int toPage(void) • bool newPage(void) • QPaintEngine *paintEngine(void) • void setPageSizeMM(QSizeF) 70.66. QPrinter Class 736
- 760. Ring Documentation, Release1.4.1 70.67 QFont Class C++ Reference : http://doc.qt.io/qt-5/QFont.html Parameters : QString, int, int, bool • bool bold(void) • int capitalization(void) • QString defaultFamily(void) • bool exactMatch(void) • QString family(void) • bool fixedPitch(void) • bool fromString(QString) • int hintingPreference(void) • bool isCopyOf(QFont) • bool italic(void) • bool kerning(void) • QString key(void) • QString lastResortFamily(void) • QString lastResortFont(void) • double letterSpacing(void) • int letterSpacingType(void) • bool overline(void) • int pixelSize(void) • int pointSize(void) • double pointSizeF(void) • bool rawMode(void) • QString rawName(void) • QFont resolve(QFont) • void setBold(bool enable) • void setCapitalization(QFont::Capitalization caps) • void setFamily(QString) • void setFixedPitch(bool enable) • void setHintingPreference(QFont::HintingPreference hintingPreference) • void setItalic(bool enable) • void setKerning(bool enable) • void setLetterSpacing(QFont::SpacingType type, double spacing) • void setOverline(bool enable) 70.67. QFont Class 737
- 761. Ring Documentation, Release1.4.1 • void setPixelSize(int pixelSize) • void setPointSize(int pointSize) • void setPointSizeF(double pointSize) • void setRawMode(bool enable) • void setRawName(QString) • void setStretch(int factor) • void setStrikeOut(bool enable) • void setStyle(QFont::Style style) • void setStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy) • void setStyleName(QString) • void setStyleStrategy(QFont::StyleStrategy s) • void setUnderline(bool enable) • void setWeight(int weight) • void setWordSpacing(double spacing) • int stretch(void) • bool strikeOut(void) • int style(void) • int styleHint(void) • QString styleName(void) • int styleStrategy(void) • QString toString(void) • bool underline(void) • int weight(void) • double wordSpacing(void) • void insertSubstitution(QString,QString) • void insertSubstitutions(QString,QStringList) • QString substitute(QString) • QStringList substitutes(QString) • QStringList substitutions(void) 70.68 QBrush Class C++ Reference : http://doc.qt.io/qt-5/QBrush.html Parameters : void • QColor color(void) • QGradient *gradient(void) 70.68. QBrush Class 738
- 762. Ring Documentation, Release1.4.1 • bool isOpaque(void) • QMatrix matrix(void) • void setColor(QColor) • void setMatrix(QMatrix) • void setStyle(Qt::BrushStyle style) • void setTexture(QPixmap) • void setTextureImage(QImage) • void setTransform(QTransform) • int style(void) • void swap(QBrush) • QPixmap texture(void) • QImage textureImage(void) • QTransform transform(void) 70.69 QByteArray Class C++ Reference : http://doc.qt.io/qt-5/QByteArray.html Parameters : void • QByteArray append(const char *str) • char at(int i) • int capacity(void) • void chop(int n) • void clear(void) • const char *constData(void) • bool contains(const char *str) • int count(const char *str) • const char *data(void) • bool endsWith(const char *str) • QByteArray fill(char ch, int size) • int indexOf(const char *str, int from) • QByteArray insert(int i, const char *str, int len) • bool isEmpty(void) • bool isNull(void) • int lastIndexOf(const char *str, int from) • QByteArray left(int len) • QByteArray leftJustified(int width, char fill, bool truncate) 70.69. QByteArray Class 739
- 763. Ring Documentation, Release1.4.1 • int length(void) • QByteArray mid(int pos, int len) • QByteArray prepend(const char *str, int len) • void push_back(const char *str) • void push_front(const char *str) • QByteArray remove(int pos, int len) • QByteArray repeated(int times) • QByteArray replace(int pos, int len, const char *after, int alen) • void reserve(int size) • void resize(int size) • QByteArray right(int len) • QByteArray rightJustified(int width, char fill, bool truncate) • QByteArray setNum(int n, int base) • QByteArray setRawData(const char *data, uint size) • QByteArray simplified(void) • int size(void) • void squeeze(void) • bool startsWith(const char *str) • void swap(QByteArray other) • QByteArray toBase64(void) • double toDouble(bool * ok) • float toFloat(bool * ok) • QByteArray toHex(void) • int toInt(bool *ok, int base) • long toLong(bool *ok, int base) • qlonglong toLongLong(bool *ok, int base) • QByteArray toLower(void) • QByteArray toPercentEncoding(QByteArray,QByteArray, char percent) • short toShort(bool *ok, int base) • int toUInt(bool *ok, int base) • int toULong(bool *ok, int base) • int toULongLong(bool * ok, int base) • int toUShort(bool * ok, int base) • QByteArray toUpper(void) • QByteArray trimmed(void) • void truncate(int pos) 70.69. QByteArray Class 740
- 764. Ring Documentation, Release1.4.1 • QByteArray fromBase64(QByteArray) • QByteArray fromHex(QByteArray) • QByteArray fromPercentEncoding(QByteArray, char percent) • QByteArray fromRawData(const char *data, int size) • QByteArray number(int n, int base) 70.70 QIODevice Class C++ Reference : http://doc.qt.io/qt-5/QIODevice.html Parameters : void • QString errorString(void) • bool getChar(char *c) • bool isOpen(void) • bool isReadable(void) • bool isTextModeEnabled(void) • bool isWritable(void) • int openMode(void) • int peek(char *data, int maxSize) • int read(char *data, int maxSize) • int readLine(char *data, int maxSize) • void ungetChar(char c) • int write(const char *data, int maxSize) • void setaboutToCloseEvent(const char *) • void setbytesWrittenEvent(const char *) • void setreadChannelFinishedEvent(const char *) • void setreadyReadEvent(const char *) • const char *getaboutToCloseEvent(void) • const char *getbytesWrittenEvent(void) • const char *getreadChannelFinishedEvent(void) • const char *getreadyReadEvent(void) 70.71 QAbstractSocket Class C++ Reference : http://doc.qt.io/qt-5/QAbstractSocket.html Parameters : void Parent Class : QIODevice • void abort(void) 70.70. QIODevice Class 741
- 765. Ring Documentation, Release1.4.1 • bool bind(QHostAddress address, int port, QAbstractSocket::BindFlag mode) • void connectToHost(QString hostName, int port, QIODevice::OpenModeFlag openMode, QAbstract- Socket::NetworkLayerProtocol protocol) • void disconnectFromHost(void) • int error(void) • bool flush(void) • bool isValid(void) • QHostAddress localAddress(void) • int localPort(void) • int pauseMode(void) • QHostAddress peerAddress(void) • QString peerName(void) • int peerPort(void) • QNetworkProxy proxy(void) • int readBufferSize(void) • void resume(void) • void setPauseMode(QAbstractSocket::PauseMode pauseMode) • void setProxy(QNetworkProxy networkProxy) • void setReadBufferSize(int size) • bool setSocketDescriptor(qintptr socketDescriptor, QAbstractSocket::SocketState socketState, QIODe- vice::OpenModeFlag openMode) • void setSocketOption(QAbstractSocket::SocketOption option, QVariant value) • int *socketDescriptor(void) • QVariant socketOption(QAbstractSocket::SocketOption option) • int socketType(void) • int state(void) • bool waitForConnected(int msecs) • bool waitForDisconnected(int msecs) • bool atEnd(void) • int bytesAvailable(void) • int bytesToWrite(void) • bool canReadLine(void) • void close(void) • bool isSequential(void) • bool waitForBytesWritten(int msecs) • bool waitForReadyRead(int msecs) • void setconnectedEvent(const char *) 70.71. QAbstractSocket Class 742
- 766. Ring Documentation, Release1.4.1 • void setdisconnectedEvent(const char *) • void seterrorEvent(const char *) • void sethostFoundEvent(const char *) • void setproxyAuthenticationRequiredEvent(const char *) • void setstateChangedEvent(const char *) • const char *getconnectedEvent(void) • const char *getdisconnectedEvent(void) • const char *geterrorEvent(void) • const char *gethostFoundEvent(void) • const char *getproxyAuthenticationRequiredEvent(void) • const char *getstateChangedEvent(void) 70.72 QNetworkProxy Class C++ Reference : http://doc.qt.io/qt-5/QNetworkProxy.html Parameters : void • int capabilities(void) • bool hasRawHeader(QByteArray headerName) • QVariant header(QNetworkRequest::KnownHeaders header) • QString hostName(void) • bool isCachingProxy(void) • bool isTransparentProxy(void) • QString password(void) • int port(void) • QByteArray rawHeader(QByteArray headerName) • void setCapabilities(QNetworkProxy::Capability capabilities) • void setHeader(QNetworkRequest::KnownHeaders header, QVariant value) • void setHostName(QString hostName) • void setPassword(QString password) • void setPort(int port) • void setRawHeader(QByteArray headerName, QByteArray headerValue) • void setType(QNetworkProxy::ProxyType type) • void setUser(QString user) • void swap(QNetworkProxy other) • int type(void) • QString user(void) 70.72. QNetworkProxy Class 743
- 767. Ring Documentation, Release1.4.1 • QNetworkProxy applicationProxy(void) • void setApplicationProxy(QNetworkProxy networkProxy) 70.73 QTcpSocket Class C++ Reference : http://doc.qt.io/qt-5/QTcpSocket.html Parameters : QObject * Parent Class : QAbstractSocket • void setconnectedEvent(const char *) • void setdisconnectedEvent(const char *) • void seterrorEvent(const char *) • void sethostFoundEvent(const char *) • void setproxyAuthenticationRequiredEvent(const char *) • void setstateChangedEvent(const char *) • void setaboutToCloseEvent(const char *) • void setbytesWrittenEvent(const char *) • void setreadChannelFinishedEvent(const char *) • void setreadyReadEvent(const char *) • const char *getconnectedEvent(void) • const char *getdisconnectedEvent(void) • const char *geterrorEvent(void) • const char *gethostFoundEvent(void) • const char *getproxyAuthenticationRequiredEvent(void) • const char *getstateChangedEvent(void) • const char *getaboutToCloseEvent(void) • const char *getbytesWrittenEvent(void) • const char *getreadChannelFinishedEvent(void) • const char *getreadyReadEvent(void) 70.74 QTcpServer Class C++ Reference : http://doc.qt.io/qt-5/QTcpServer.html Parameters : QWidget * • void close(void) • QString errorString(void) • bool hasPendingConnections(void) • bool isListening(void) 70.73. QTcpSocket Class 744
- 768. Ring Documentation, Release1.4.1 • bool listen(QHostAddress, int port) • int maxPendingConnections(void) • QTcpSocket *nextPendingConnection(void) • void pauseAccepting(void) • QNetworkProxy proxy(void) • void resumeAccepting(void) • QHostAddress serverAddress(void) • int serverError(void) • int serverPort(void) • void setMaxPendingConnections(int numConnections) • void setProxy(QNetworkProxy) • bool setSocketDescriptor(qintptr socketDescriptor) • int *socketDescriptor(void) • bool waitForNewConnection(int msec, bool *timedOut) • void setacceptErrorEvent(const char *) • void setnewConnectionEvent(const char *) • const char *getacceptErrorEvent(void) • const char *getnewConnectionEvent(void) 70.75 QHostAddress Class C++ Reference : http://doc.qt.io/qt-5/QHostAddress.html Parameters : void • void clear(void) • bool isInSubnet(QHostAddress, int netmask) • bool isNull(void) • int protocol(void) • QString scopeId(void) • bool setAddress(QString) • int toIPv4Address(void) • Q_IPV6ADDR toIPv6Address(void) • QString toString(void) 70.75. QHostAddress Class 745
- 769. Ring Documentation, Release1.4.1 70.76 QHostInfo Class C++ Reference : http://doc.qt.io/qt-5/QHostInfo.html Parameters : void • int error(void) • QString errorString(void) • QString hostName(void) • int lookupId(void) • void setError(QHostInfo::HostInfoError error) • void setErrorString(QString) • void setHostName(QString) • void setLookupId(int id) • void abortHostLookup(int id) • QHostInfo fromName(QString) • QString localDomainName(void) • QString localHostName(void) • int lookupHost(QString, QObject *receiver, const char *member) 70.77 QFileInfo Class C++ Reference : http://doc.qt.io/qt-5/QFileInfo.html Parameters : void • QDir absoluteDir(void) • QString absoluteFilePath(void) • QString absolutePath(void) • QString baseName(void) • QString bundleName(void) • bool caching(void) • QString canonicalFilePath(void) • QString canonicalPath(void) • QString completeBaseName(void) • QString completeSuffix(void) • QDateTime created(void) • QDir dir(void) • bool exists(void) • QString fileName(void) • QString filePath(void) 70.76. QHostInfo Class 746
- 770. Ring Documentation, Release1.4.1 • QString group(void) • int groupId(void) • bool isAbsolute(void) • bool isBundle(void) • bool isDir(void) • bool isExecutable(void) • bool isFile(void) • bool isHidden(void) • bool isNativePath(void) • bool isReadable(void) • bool isRelative(void) • bool isRoot(void) • bool isSymLink(void) • bool isWritable(void) • QDateTime lastModified(void) • QDateTime lastRead(void) • bool makeAbsolute(void) • QString owner(void) • uint ownerId(void) • QString path(void) • bool permission(QFileDevice::Permission permissions) • int permissions(void) • void refresh(void) • void setCaching(bool enable) • void setFile(QString) • int size(void) • QString suffix(void) • void swap(QFileInfo) • QString symLinkTarget(void) 70.78 QDirModel Class C++ Reference : http://doc.qt.io/qt-5/QDirModel.html Parameters : void • QIcon fileIcon(QModelIndex) • QFileInfo fileInfo(QModelIndex) 70.78. QDirModel Class 747
- 771. Ring Documentation, Release1.4.1 • QString fileName(QModelIndex) • QString filePath(QModelIndex) • int filter(void) • QFileIconProvider *iconProvider(void) • QModelIndex index(QString path, int column) • bool isDir(QModelIndex) • bool isReadOnly(void) • bool lazyChildCount(void) • QModelIndex mkdir(QModelIndex parent, QString name) • QStringList nameFilters(void) • bool remove(QModelIndex index) • bool resolveSymlinks(void) • bool rmdir(QModelIndex index) • void setFilter(QDir::Filter filters) • void setIconProvider(QFileIconProvider *provider) • void setLazyChildCount(bool enable) • void setNameFilters(QStringList filters) • void setReadOnly(bool enable) • void setResolveSymlinks(bool enable) • void setSorting(QDir::SortFlag sort) • int sorting(void) • void refresh(QModelIndex parent) 70.79 QFontDialog Class C++ Reference : http://doc.qt.io/qt-5/QFontDialog.html Parameters : void Parent Class : QDialog • QFont currentFont(void) • void open(QObject *receiver, const char *member) • int options(void) • QFont selectedFont(void) • void setCurrentFont(QFont) • void setOption(QFontDialog::FontDialogOption option, bool on) • void setOptions(QFontDialog::FontDialogOption options) • bool testOption(QFontDialog::FontDialogOption option) 70.79. QFontDialog Class 748
- 772. Ring Documentation, Release1.4.1 • int getfont(void) 70.80 QDialog Class C++ Reference : http://doc.qt.io/qt-5/QDialog.html Parameters : QWidget *parent Parent Class : QWidget • bool isSizeGripEnabled(void) • int result(void) • void setModal(bool modal) • void setResult(int i) • void setSizeGripEnabled(bool) • void accept(void) • void done(int r) # In RingQt use : void donedialog(int r) • int exec(void) • void open(void) • void reject(void) 70.81 QTextCursor Class C++ Reference : http://doc.qt.io/qt-5/QTextCursor.html Parameters : void • int anchor(void) • bool atBlockEnd(void) • bool atBlockStart(void) • bool atEnd(void) • bool atStart(void) • void beginEditBlock(void) • QTextBlock block(void) • QTextCharFormat blockCharFormat(void) • QTextBlockFormat blockFormat(void) • int blockNumber(void) • QTextCharFormat charFormat(void) • void clearSelection(void) • int columnNumber(void) • QTextList *createList(QTextListFormat) • QTextFrame *currentFrame(void) 70.80. QDialog Class 749
- 773. Ring Documentation, Release1.4.1 • QTextList *currentList(void) • QTextTable *currentTable(void) • void deleteChar(void) • void deletePreviousChar(void) • QTextDocument *document(void) • void endEditBlock(void) • bool hasComplexSelection(void) • bool hasSelection(void) • void insertBlock(void) • void insertFragment(QTextDocumentFragment) • QTextFrame *insertFrame(QTextFrameFormat) • void insertHtml(QString) • void insertImage(QTextImageFormat) • QTextList *insertList(QTextListFormat) • QTextTable * insertTable(int rows, int columns, QTextTableFormat) • void insertText(QString) • bool isCopyOf(QTextCursor) • bool isNull(void) • void joinPreviousEditBlock(void) • bool keepPositionOnInsert(void) • void mergeBlockCharFormat(QTextCharFormat) • void mergeBlockFormat(QTextBlockFormat) • void mergeCharFormat(QTextCharFormat) • bool movePosition(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode, int n) • int position(void) • int positionInBlock(void) • void removeSelectedText(void) • void select(QTextCursor::SelectionType selection) • void selectedTableCells(int *firstRow, int *numRows, int *firstColumn, int *numColumns) • QString selectedText(void) • QTextDocumentFragment selection(void) • int selectionEnd(void) • int selectionStart(void) • void setBlockCharFormat(QTextCharFormat) • void setBlockFormat(QTextBlockFormat) • void setCharFormat(QTextCharFormat) 70.81. QTextCursor Class 750
- 774. Ring Documentation, Release1.4.1 • void setKeepPositionOnInsert(bool b) • void setPosition(int pos, QTextCursor::MoveMode m) • void setVerticalMovementX(int x) • void setVisualNavigation(bool b) • int verticalMovementX(void) • bool visualNavigation(void) 70.82 QColorDialog Class C++ Reference : http://doc.qt.io/qt-5/QColorDialog.html Parameters : void Parent Class : QDialog • QColor currentColor(void) • void open(void) • int options(void) • QColor selectedColor(void) • void setCurrentColor(QColor) • void setOption(QColorDialog::ColorDialogOption option, bool on ) • void setOptions(QColorDialog::ColorDialogOption options) • bool testOption(QColorDialog::ColorDialogOption option) • QColor customColor(int index) • int customCount(void) • void setCustomColor(int index, int color) • void setStandardColor(int index, int color) • int getcolor(void) 70.83 QStringList Class C++ Reference : http://doc.qt.io/qt-5/QStringList.html Parameters : void • QString join(QString) • void sort(void) • int removeDuplicates(void) • QStringList filter(QString, Qt::CaseSensitivity) • QStringList replaceInStrings(QString,QString, Qt::CaseSensitivity) • void append(QString) • QString at(int) 70.82. QColorDialog Class 751
- 775. Ring Documentation, Release1.4.1 • QString back(void) • void clear(void) • bool contains(QString) • int count(void) • bool empty(void) • bool endsWith(QString) • QString first(void) • QString front(void) • int indexOf(QString, int) • void insert(int, QString) • bool isEmpty(void) • QString last(void) • int lastIndexOf(QString,int) • int length(void) • void move(int,int) • void pop_back(void) • void pop_front(void) • void prepend(QString) • void push_back(QString) • void push_front(QString) • int removeAll(QString) • void removeAt(int) • void removeFirst(void) • void removeLast(void) • bool removeOne(QString) • void replace(int,QString) • void reserve(int) • int size(void) • bool startsWith(QString) • void swap(int,int) • QString takeAt(int) • QString takeFirst(void) • QString takeLast(void) • QString value(int) 70.83. QStringList Class 752
- 776. Ring Documentation, Release1.4.1 70.84 QKeySequence Class C++ Reference : http://doc.qt.io/qt-5/QKeySequence.html Parameters : QString 70.85 QLCDNumber Class C++ Reference : http://doc.qt.io/qt-5/QLCDNumber.html Parameters : QWidget * Parent Class : QFrame • bool checkOverflow(double num) • int digitCount(void) • int intValue(void) • int mode(void) • int segmentStyle(void) • void setDigitCount(int numDigits) • void setMode(QLCDNumber::Mode) • void setSegmentStyle(QLCDNumber::SegmentStyle) • bool smallDecimalPoint(void) • double value(void) • void display(double) • void setBinMode(void) • void setDecMode(void) • void setHexMode(void) • void setOctMode(void) • void setSmallDecimalPoint(bool) 70.86 QInputDialog Class C++ Reference : http://doc.qt.io/qt-5/QInputDialog.html Parameters : QWidget * Parent Class : QDialog • QString cancelButtonText(void) • QStringList comboBoxItems(void) • int doubleDecimals(void) • double doubleMaximum(void) • double doubleMinimum(void) 70.84. QKeySequence Class 753
- 777. Ring Documentation, Release1.4.1 • double doubleValue(void) • int inputMode(void) • int intMaximum(void) • int intMinimum(void) • int intStep(void) • int intValue(void) • bool isComboBoxEditable(void) • QString labelText(void) • QString okButtonText(void) • void open(QObject *receiver, const char *member) • int options(void) • void setCancelButtonText(QString) • void setComboBoxEditable(bool editable) • void setComboBoxItems(QStringList) • void setDoubleDecimals(int decimals) • void setDoubleMaximum(double max) • void setDoubleMinimum(double min) • void setDoubleRange(double min, double max) • void setDoubleValue(double value) • void setInputMode(QInputDialog::InputMode mode) • void setIntMaximum(int max) • void setIntMinimum(int min) • void setIntRange(int min, int max) • void setIntStep(int step) • void setIntValue(int value) • void setLabelText(QString) • void setOkButtonText(QString) • void setOption(QInputDialog::InputDialogOption option, bool on) • void setOptions(QInputDialog::InputDialogOption options) • void setTextEchoMode(QLineEdit::EchoMode mode) • void setTextValue(QString) • bool testOption(QInputDialog::InputDialogOption option) • int textEchoMode(void) • QString textValue(void) • double getDouble(QWidget *parent,QString,QString, double value, double min, double max , int decimals, bool *ok, Qt::WindowType flags) 70.86. QInputDialog Class 754
- 778. Ring Documentation, Release1.4.1 • int getInt(QWidget *parent,QString,QString, int value, int min, int max, int step, bool *ok, Qt::WindowType flags) 70.87 QAllEvents Class Parameters : QWidget * Parent Class : QWidget • void accept(void) • void ignore(void) • int getKeyCode(void) • int getModifiers(void) • int getx(void) • int gety(void) • int getglobalx(void) • int getglobaly(void) • int getbutton(void) • int getbuttons(void) • void setKeyPressEvent(const char *cStr) • void setMouseButtonPressEvent(const char *cStr) • void setMouseButtonReleaseEvent(const char *cStr) • void setMouseButtonDblClickEvent(const char *cStr) • void setMouseMoveEvent(const char *cStr) • void setCloseEvent(const char *cStr) • void setContextMenuEvent(const char *cStr) • void setDragEnterEvent(const char *cStr) • void setDragLeaveEvent(const char *cStr) • void setDragMoveEvent(const char *cStr) • void setDropEvent(const char *cStr) • void setEnterEvent(const char *cStr) • void setFocusInEvent(const char *cStr) • void setFocusOutEvent(const char *cStr) • void setKeyReleaseEvent(const char *cStr) • void setLeaveEvent(const char *cStr) • void setNonClientAreaMouseButtonDblClickEvent(const char *cStr) • void setNonClientAreaMouseButtonPressEvent(const char *cStr) • void setNonClientAreaMouseButtonReleaseEvent(const char *cStr) • void setNonClientAreaMouseMoveEvent(const char *cStr) 70.87. QAllEvents Class 755
- 779. Ring Documentation, Release1.4.1 • void setMoveEvent(const char *cStr) • void setResizeEvent(const char *cStr) • void setWindowActivateEvent(const char *cStr) • void setWindowBlockedEvent(const char *cStr) • void setWindowDeactivateEvent(const char *cStr) • void setWindowStateChangeEvent(const char *cStr) • void setWindowUnblockedEvent(const char *cStr) • void setPaintEvent(const char *cStr) • const char *getKeyPressEvent(void) • const char *getMouseButtonPressEvent(void) • const char *getMouseButtonReleaseEvent(void) • const char *getMouseButtonDblClickEvent(void) • const char *getMouseMoveEvent(void) • const char *getCloseEvent(void) • const char *getContextMenuEvent(void) • const char *getDragEnterEvent(void) • const char *getDragLeaveEvent(void) • const char *getDragMoveEvent(void) • const char *getDropEvent(void) • const char *getEnterEvent(void) • const char *getFocusInEvent(void) • const char *getFocusOutEvent(void) • const char *getKeyReleaseEvent(void) • const char *getLeaveEvent(void) • const char *getNonClientAreaMouseButtonDblClickEvent(void) • const char *getNonClientAreaMouseButtonPressEvent(void) • const char *getNonClientAreaMouseButtonReleaseEvent(void) • const char *getNonClientAreaMouseMoveEvent(void) • const char *getMoveEvent(void) • const char *getResizeEvent(void) • const char *getWindowActivateEvent(void) • const char *getWindowBlockedEvent(void) • const char *getWindowDeactivateEvent(void) • const char *getWindowStateChangeEvent(void) • const char *getWindowUnblockedEvent(void) • const char *getPaintEvent(void) 70.87. QAllEvents Class 756
- 780. Ring Documentation, Release1.4.1 • void setEventOutput(bool x) • QObject *getParentObject(void) • QWidget *getParentWidget(void) 70.88 QDesktopWidget Class C++ Reference : http://doc.qt.io/qt-5/QDesktopWidget.html Parameters : void Parent Class : QWidget • QRect availableGeometry(int screen) • bool isVirtualDesktop(void) • int primaryScreen(void) • QWidget *screen(int screen) • int screenCount(void) • QRect screenGeometry(int screen) • int screenNumber(QWidget *widget) 70.89 QRect Class C++ Reference : http://doc.qt.io/qt-5/QRect.html Parameters : void • void adjust(int dx1, int dy1, int dx2, int dy2) • QRect adjusted(int dx1, int dy1, int dx2, int dy2) • int bottom(void) • QPoint bottomLeft(void) • QPoint bottomRight(void) • QPoint center(void) • bool contains(int x, int y, bool proper) • void getCoords(int *x1, int *y1, int *x2, int *y2) • void getRect(int *x, int *y, int *width, int *height) • int height(void) • QRect intersected(QRect) • bool intersects(QRect) • bool isEmpty(void) • bool isNull(void) • bool isValid(void) • int left(void) 70.88. QDesktopWidget Class 757
- 781. Ring Documentation, Release1.4.1 • void moveBottom(int y) • void moveBottomLeft(QPoint) • void moveBottomRight(QPoint) • void moveCenter(QPoint) • void moveLeft(int x) • void moveRight(int x) • void moveTo(int x, int y) • void moveTop(int y) • void moveTopLeft(QPoint) • void moveTopRight(QPoint) • QRect normalized(void) • int right(void) • void setBottom(int y) • void setBottomLeft(QPoint) • void setBottomRight(QPoint) • void setCoords(int x1, int y1, int x2, int y2) • void setHeight(int height) • void setLeft(int x) • void setRect(int x, int y, int width, int height) • void setRight(int x) • void setSize(QSize) • void setTop(int y) • void setTopLeft(QPoint) • void setTopRight(QPoint) • void setWidth(int width) • void setX(int x) • void setY(int y) • QSize size(void) • int top(void) • QPoint topLeft(void) • QPoint topRight(void) • void translate(int dx, int dy) • QRect translated(int dx, int dy) • QRect united(QRect) • int width(void) • int x(void) 70.89. QRect Class 758
- 782. Ring Documentation, Release1.4.1 • int y(void) 70.90 QTextDocument Class C++ Reference : http://doc.qt.io/qt-5/QTextDocument.html Parameters : void Parent Class : QObject • void addResource(int type,QUrl name, QVariant resource) • void adjustSize(void) • QVector<QTextFormat> allFormats(void) • int availableRedoSteps(void) • int availableUndoSteps(void) • QTextBlock begin(void) • int blockCount(void) • QChar characterAt(int pos) • int characterCount(void) • void clearUndoRedoStacks(QTextDocument::Stacks stacksToClear ) • QTextDocument *clone(QObject *parent ) • int defaultCursorMoveStyle(void) • QFont defaultFont(void) • QString defaultStyleSheet(void) • QTextOption defaultTextOption(void) • QAbstractTextDocumentLayout *documentLayout(void) • double documentMargin(void) • void drawContents(QPainter *p, QRectF rect) • QTextBlock end(void) # In RingQt use : QTextBlock enddoc(void) • QTextCursor find(QString subString, QTextCursor cursor, QTextDocument::FindFlag options ) • QTextBlock findBlock(int pos) • QTextBlock findBlockByLineNumber(int lineNumber) • QTextBlock findBlockByNumber(int blockNumber) • QTextBlock firstBlock(void) • double idealWidth(void) • double indentWidth(void) • bool isEmpty(void) • bool isModified(void) • bool isRedoAvailable(void) 70.90. QTextDocument Class 759
- 783. Ring Documentation, Release1.4.1 • bool isUndoAvailable(void) • bool isUndoRedoEnabled(void) • QTextBlock lastBlock(void) • int lineCount(void) • void markContentsDirty(int position, int length) • int maximumBlockCount(void) • QString metaInformation(QTextDocument::MetaInformation info) • QTextObject *object(int objectIndex) • QTextObject *objectForFormat(QTextFormat f) • int pageCount(void) • QSizeF pageSize(void) • void print(QPrinter *printer) • void redo(QTextCursor *cursor) • QVariant resource(int type, QUrl name) • int revision(void) • QTextFrame *rootFrame(void) • void setDefaultCursorMoveStyle(Qt::CursorMoveStyle style) • void setDefaultFont(QFont font) • void setDefaultStyleSheet(QString sheet) • void setDefaultTextOption(QTextOption option) • void setDocumentLayout(QAbstractTextDocumentLayout * layout) • void setDocumentMargin(double margin) • void setHtml(QString html) • void setIndentWidth(double width) • void setMaximumBlockCount(int maximum) • void setMetaInformation(QTextDocument::MetaInformation info, QString string) • void setPageSize(QSizeF size) • void setPlainText(QString text) • void setTextWidth(double width) • void setUndoRedoEnabled(bool enable) • void setUseDesignMetrics(bool b) • QSizeF size(void) • qreal textWidth(void) • QString toHtml(QByteArray encoding) • QString toPlainText(void) • void undo(QTextCursor *cursor) 70.90. QTextDocument Class 760
- 784. Ring Documentation, Release1.4.1 • bool useDesignMetrics(void) • void setModified(bool m) 70.91 QTextBlock Class C++ Reference : http://doc.qt.io/qt-5/QTextBlock.html Parameters : void • int blockFormatIndex(void) • int blockNumber(void) • QTextCharFormat charFormat(void) • int charFormatIndex(void) • void clearLayout(void) • bool contains(int position) • QTextDocument *document(void) • bool isValid(void) • bool isVisible(void) • QTextLayout * layout(void) • int length(void) • int lineCount(void) • QTextBlock next(void) # In RingQt use : QTextBlock nextblock(void) • int position(void) • QTextBlock previous(void) • int revision(void) • void setLineCount(int count) • void setRevision(int rev) • void setUserData(QTextBlockUserData * data) • void setUserState(int state) • void setVisible(bool visible) • QString text(void) • int textDirection(void) • QTextList * textList(void) • QTextBlockUserData * userData(void) • int userState(void) 70.91. QTextBlock Class 761
- 785. Ring Documentation, Release1.4.1 70.92 QTime Class C++ Reference : http://doc.qt.io/qt-5/QTime.html Parameters : void • QTime addMSecs(int ms) • QTime addSecs(int s) • int elapsed(void) • int hour(void) • bool isNull(void) • bool isValid(void) • int minute(void) • int msec(void) • int msecsSinceStartOfDay(void) • int msecsTo(QTime) • int restart(void) • int second(void) • int secsTo(QTime) • bool setHMS(int h, int m, int s, int ms) • void start(void) • QString toString(QString) • QTime currentTime(void) • QTime fromMSecsSinceStartOfDay(int msecs) • QTime fromString(QString,QString) 70.93 QListWidgetItem Class C++ Reference : http://doc.qt.io/qt-5/QListWidgetItem.html Parameters : void • QBrush background(void) • Qt::CheckState checkState(void) • Qt::ItemFlags flags(void) • QFont font(void) • QBrush foreground(void) • QIcon icon(void) • bool isHidden(void) • bool isSelected(void) • QListWidget *listWidget(void) 70.92. QTime Class 762
- 786. Ring Documentation, Release1.4.1 • void setBackground(QBrush brush) • void setCheckState(Qt::CheckState state) • void setFlags(Qt::ItemFlags flags) • void setFont(QFont font) • void setForeground(QBrush brush) • void setHidden(bool hide) • void setIcon(QIcon icon) • void setSelected(bool select) • void setSizeHint(QSize size) • void setStatusTip(QString statusTip) • void setText(QString text) • void setTextAlignment(int alignment) • void setToolTip(QString toolTip) • void setWhatsThis(QString whatsThis) • QSize sizeHint(void) • QString statusTip(void) • QString text(void) • int textAlignment(void) • QString toolTip(void) • int type(void) • QString whatsThis(void) 70.94 QSystemTrayIcon Class C++ Reference : http://doc.qt.io/qt-5/QSystemTrayIcon.html Parameters : void • QMenu *contextMenu(void) • QRect geometry(void) • QIcon icon(void) • bool isVisible(void) • void setContextMenu(QMenu *menu) • void setIcon(QIcon) • void setToolTip(QString) • QString toolTip(void) • void hide(void) • void setVisible(bool visible) 70.94. QSystemTrayIcon Class 763
- 787. Ring Documentation, Release1.4.1 • void show(void) • void showMessage(QString, QString, QSystemTrayIcon::MessageIcon, int millisecondsTimeoutHint) • bool isSystemTrayAvailable(void) • bool supportsMessages(void) 70.95 QDate Class C++ Reference : http://doc.qt.io/qt-5/QDate.html Parameters : void • QDate addDays(int ndays) • QDate addMonths(int nmonths) • QDate addYears(int nyears) • int day(void) • int dayOfWeek(void) • int dayOfYear(void) • int daysInMonth(void) • int daysInYear(void) • int daysTo(QDate) • void getDate(int * year, int * month, int * day) • bool isNull(void) • bool isValid(void) • int month(void) • bool setDate(int year, int month, int day) • int toJulianDay(void) • QString toString(QString) • int weekNumber(int * yearNumber) • int year(void) • QDate currentDate(void) • QDate fromJulianDay(int jd) • QDate fromString(QString, QString) • bool isLeapYear(int year) • QString longDayName(int weekday) • QString longMonthName(int month) • QString shortDayName(int weekday) • QString shortMonthName(int month) 70.95. QDate Class 764
- 788. Ring Documentation, Release1.4.1 70.96 QTextCodec Class C++ Reference : http://doc.qt.io/qt-5/QTextCodec.html • QTextCodec *codecForName(const char *name) • void setCodecForLocale(QTextCodec *c) 70.97 QSqlDatabase Class C++ Reference : http://doc.qt.io/qt-5/QSqlDatabase.html Parameters : void • void close(void) • bool commit(void) • QString connectOptions(void) • QString connectionName(void) • QString databaseName(void) • QSqlDriver *driver(void) • QString driverName(void) • QSqlQuery exec(QString) • QString hostName(void) • bool isOpen(void) • bool isOpenError(void) • bool isValid(void) • QSqlError lastError(void) • QSql::NumericalPrecisionPolicy numericalPrecisionPolicy(void) • bool open(void) • QString password(void) • int port(void) • QSqlIndex primaryIndex(QString) • QSqlRecord record(QString) • bool rollback(void) • void setConnectOptions(QString) • void setDatabaseName(QString) • void setHostName(QString) • void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy) • void setPassword(QString) • void setPort(int port) • void setUserName(QString) 70.96. QTextCodec Class 765
- 789. Ring Documentation, Release1.4.1 • QStringList tables(QSql::TableType type) • bool transaction(void) • QString userName(void) • QSqlDatabase addDatabase(QString) • QSqlDatabase cloneDatabase(QSqlDatabase, QString) • QStringList connectionNames(void) • bool contains(QString) • QSqlDatabase database(QString , bool) • QStringList drivers(void) • bool isDriverAvailable(QString) • void registerSqlDriver(QString, QSqlDriverCreatorBase *) • void removeDatabase(QString) 70.98 QSqlDriver Class C++ Reference : http://doc.qt.io/qt-5/QSqlDriver.html Parameters : void • QSqlError lastError(void) • QSql::NumericalPrecisionPolicy numericalPrecisionPolicy(void) • void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy) 70.99 QSqlQuery Class C++ Reference : http://doc.qt.io/qt-5/QSqlQuery.html Parameters : void • void addBindValue(QVariant, QSql::ParamType paramType) • int at(void) • void bindValue(QString, QVariant, QSql::ParamType paramType) • QVariant boundValue(QString) • void clear(void) • QSqlDriver * driver(void) • bool exec(QString) • bool execBatch(QSqlQuery::BatchExecutionMode mode) • QString executedQuery(void) • void finish(void) • bool first(void) • bool isActive(void) 70.98. QSqlDriver Class 766
- 790. Ring Documentation, Release1.4.1 • bool isForwardOnly(void) • bool isNull(int field) • bool isSelect(void) • bool isValid(void) • bool last(void) • QSqlError lastError(void) • QVariant lastInsertId(void) • QString lastQuery(void) • bool next(void) # In RingQt use : bool movenext(void) • bool nextResult(void) • int numRowsAffected(void) • QSql::NumericalPrecisionPolicy numericalPrecisionPolicy(void) • bool prepare(QString) • bool previous(void) • QSqlRecord record(void) • QSqlResult *result(void) • bool seek(int index, bool relative) • void setForwardOnly(bool forward) • void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy) • int size(void) • QVariant value(int index) 70.100 QSqlError Class C++ Reference : http://doc.qt.io/qt-5/QSqlError.html Parameters : QString, QString, QSqlError::ErrorType • QString databaseText(void) • QString driverText(void) • bool isValid(void) • int number(void) • void setDatabaseText(QString) • void setDriverText(QString) • void setNumber(int number) • void setType(QSqlError::ErrorType type) • QString text(void) • QSqlError::ErrorType type(void) 70.100. QSqlError Class 767
- 791. Ring Documentation, Release1.4.1 70.101 QSqlIndex Class C++ Reference : http://doc.qt.io/qt-5/QSqlIndex.html Parameters : QString, QString Parent Class : QSqlRecord • void append(QSqlField, bool) • QString cursorName(void) • bool isDescending(int i) • QString name(void) • void setCursorName(QString) • void setDescending(int i, bool desc) • void setName(QString) 70.102 QSqlRecord Class C++ Reference : http://doc.qt.io/qt-5/QSqlRecord.html Parameters : void • void append(QSqlField) • void clear(void) • void clearValues(void) • bool contains(QString) • int count(void) • QSqlField field(int index) • QString fieldName(int index) • int indexOf(QString) • void insert(int pos, QSqlField) • bool isEmpty(void) • bool isGenerated(QString) • bool isNull(QString) • void remove(int pos) • void replace(int pos, QSqlField) • void setGenerated(QString, bool generated) • void setNull(int index) • void setValue(int index, QVariant) • QVariant value(int index) 70.101. QSqlIndex Class 768
- 792. Ring Documentation, Release1.4.1 70.103 QSqlField Class C++ Reference : http://doc.qt.io/qt-5/QSqlField.html Parameters : QString,QVariant::Type • void clear(void) • QVariant defaultValue(void) • bool isAutoValue(void) • bool isGenerated(void) • bool isNull(void) • bool isReadOnly(void) • bool isValid(void) • int length(void) • QString name(void) • int precision(void) • RequiredStatus requiredStatus(void) • void setAutoValue(bool autoVal) • void setDefaultValue(QVariant) • void setGenerated(bool gen) • void setLength(int fieldLength) • void setName(QString) • void setPrecision(int precision) • void setReadOnly(bool readOnly) • void setRequired(bool required) • void setRequiredStatus(QSqlField::RequiredStatus required) • void setType(QVariant::Type type) • void setValue(QVariant) • QVariant::Type type(void) • QVariant value(void) 70.104 QSqlDriverCreatorBase Class C++ Reference : http://doc.qt.io/qt-5/QSqlDriverCreatorBase.html Parameters : void 70.103. QSqlField Class 769
- 793. Ring Documentation, Release1.4.1 70.105 QVariant Class C++ Reference : http://doc.qt.io/qt-5/QVariant.html Parameters : void • bool canConvert(int targetTypeId) • void clear(void) • bool convert(int targetTypeId) • bool isNull(void) • bool isValid(void) • void swap(QVariant) • QBitArray toBitArray(void) • bool toBool(void) • QByteArray toByteArray(void) • QChar toChar(void) • QDate toDate(void) • QDateTime toDateTime(void) • double toDouble(bool *ok) • QEasingCurve toEasingCurve(void) • float toFloat(bool *ok) • int toInt(bool *ok) • QJsonArray toJsonArray(void) • QJsonDocument toJsonDocument(void) • QJsonObject toJsonObject(void) • QJsonValue toJsonValue(void) • QLine toLine(void) • QLineF toLineF(void) • QLocale toLocale(void) • qlonglong toLongLong(bool *ok) • QModelIndex toModelIndex(void) • QPointF toPointF(void) • qreal toReal(bool *ok) • QRect toRect(void) • QRectF toRectF(void) • QRegExp toRegExp(void) • QRegularExpression toRegularExpression(void) • QSize toSize(void) 70.105. QVariant Class 770
- 794. Ring Documentation, Release1.4.1 • QSizeF toSizeF(void) • QStringList toStringList(void) • QTime toTime(void) • uint toUInt(bool *ok) • qulonglong toULongLong(bool *ok) • QUrl toUrl(void) • QUuid toUuid(void) • QVariant::Type type(void) • const char *typeName(void) • int userType(void) • QString toString(void) 70.106 QNetworkRequest Class C++ Reference : http://doc.qt.io/qt-5/QNetworkRequest.html Parameters : QUrl • QVariant attribute(QNetworkRequest::Attribute, QVariant) • bool hasRawHeader(QByteArray) • QVariant header(QNetworkRequest::KnownHeaders) • QObject *originatingObject(void) • QNetworkRequest::Priority priority(void) • QByteArray rawHeader(QByteArray) • void setAttribute(QNetworkRequest::Attribute, QVariant) • void setHeader(QNetworkRequest::KnownHeaders, QVariant) • void setOriginatingObject(QObject *object) • void setPriority(QNetworkRequest::Priority priority) • void setRawHeader(QByteArray, QByteArray) • void swap(QNetworkRequest) • QUrl url(void) 70.107 QNetworkAccessManager Class C++ Reference : http://doc.qt.io/qt-5/QNetworkAccessManager.html Parameters : QObject * Parent Class : QObject • void setfinishedEvent(const char *) • const char *getfinishedEvent(void) 70.106. QNetworkRequest Class 771
- 795. Ring Documentation, Release1.4.1 • QNetworkConfiguration activeConfiguration(void) • QAbstractNetworkCache *cache(void) • void clearAccessCache(void) • QNetworkConfiguration configuration(void) • void connectToHost(QString, quint16) • QNetworkReply *deleteResource(QNetworkRequest) • QNetworkReply *get(QNetworkRequest) # In RingQt use : QNetworkReply *getvalue(QNetworkRequest) • QNetworkReply *head(QNetworkRequest) • QNetworkAccessManager::NetworkAccessibility networkAccessible(void) • QNetworkReply *post(QNetworkRequest, QByteArray) • QNetworkProxy proxy(void) • QNetworkProxyFactory *proxyFactory(void) • QNetworkReply *put(QNetworkRequest, QByteArray) # In RingQt use : QNetworkReply *put- value(QNetworkRequest, QByteArray) • QNetworkReply *sendCustomRequest(QNetworkRequest, QByteArray, QIODevice *) • void setCache(QAbstractNetworkCache *cache) • void setConfiguration(QNetworkConfiguration) • void setCookieJar(QNetworkCookieJar *cookieJar) • void setNetworkAccessible(QNetworkAccessManager::NetworkAccessibility accessible) • void setProxy(QNetworkProxy) • void setProxyFactory(QNetworkProxyFactory *factory) • QStringList supportedSchemes(void) • void geteventparameters(void) 70.108 QNetworkReply Class C++ Reference : http://doc.qt.io/qt-5/QNetworkReply.html Parameters : void Parent Class : QIODevice • QVariant attribute(QNetworkRequest::Attribute code) • QNetworkReply::NetworkError error(void) • bool hasRawHeader(QByteArray) • QVariant header(QNetworkRequest::KnownHeaders header) • bool isFinished(void) • bool isRunning(void) • QNetworkAccessManager *manager(void) • QNetworkAccessManager::Operation operation(void) 70.108. QNetworkReply Class 772
- 796. Ring Documentation, Release1.4.1 • QByteArray rawHeader(QByteArray) • qint64 readBufferSize(void) • QNetworkRequest request(void) 70.109 QPainterPath Class C++ Reference : http://doc.qt.io/qt-5/QPainterPath.html Parameters : void • void addEllipse(qreal x, qreal y, qreal width, qreal height) • void addPath(QPainterPath) • void addPolygon(QPolygonF) • void addRect(qreal x, qreal y, qreal width, qreal height) • void addRegion(QRegion) • void addRoundedRect(qreal x, qreal y, qreal w, qreal h, qreal xRadius, qreal yRadius, Qt::SizeMode mode) • void addText(qreal x, qreal y, QFont, QString) • qreal angleAtPercent(qreal t) • void arcMoveTo(qreal x, qreal y, qreal width, qreal height, qreal angle) • void arcTo(qreal x, qreal y, qreal width, qreal height, qreal startAngle, qreal sweepLength) • QRectF boundingRect(void) • void closeSubpath(void) • void connectPath(QPainterPath) • bool contains(QPointF) • QRectF controlPointRect(void) • void cubicTo(qreal c1X, qreal c1Y, qreal c2X, qreal c2Y, qreal endPointX, qreal endPointY) • QPointF currentPosition(void) • QPainterPath::Element elementAt(int index) • int elementCount(void) • Qt::FillRule fillRule(void) • QPainterPath intersected(QPainterPath) • bool intersects(QRectF) • bool isEmpty(void) • qreal length(void) • void lineTo(qreal x, qreal y) • void moveTo(qreal x, qreal y) • qreal percentAtLength(qreal len) • QPointF pointAtPercent(qreal t) 70.109. QPainterPath Class 773
- 797. Ring Documentation, Release1.4.1 • void quadTo(qreal cx, qreal cy, qreal endPointX, qreal endPointY) • void setElementPositionAt(int index, qreal x, qreal y) • void setFillRule(Qt::FillRule fillRule) • QPainterPath simplified(void) • qreal slopeAtPercent(qreal t) • QPainterPath subtracted(QPainterPath) • void swap(QPainterPath) • QPolygonF toFillPolygon(QTransform) • QPainterPath toReversed(void) • void translate(qreal dx, qreal dy) • QPainterPath translated(qreal dx, qreal dy) • QPainterPath united(QPainterPath) 70.110 QImage Class C++ Reference : http://doc.qt.io/qt-5/QImage.html Parameters : void • bool allGray(void) • int bitPlaneCount(void) • uchar *bits(void) • int byteCount(void) • int bytesPerLine(void) • qint64 cacheKey(void) • QRgb color(int i) • int colorCount(void) • const uchar *constBits(void) • const uchar *constScanLine(int i) • QImage convertToFormat(QImage::Format format, Qt::ImageConversionFlags flags) • QImage copy(int x, int y, int width, int height) • QImage createAlphaMask(Qt::ImageConversionFlags flags) • QImage createHeuristicMask(bool clipTight) • QImage createMaskFromColor(QRgb color, Qt::MaskMode mode) • int depth(void) • int dotsPerMeterX(void) • int dotsPerMeterY(void) • void fill(QColor) 70.110. QImage Class 774
- 798. Ring Documentation, Release1.4.1 • QImage::Format format(void) • bool hasAlphaChannel(void) • int height(void) • void invertPixels(QImage::InvertMode mode) • bool isGrayscale(void) • bool isNull(void) • bool load(QString, const char *format) # In RingQt use : bool loadimage(QString, const char *format) • bool loadFromData(QByteArray, const char * format) • QImage mirrored(bool horizontal, bool vertical) • QPoint offset(void) • QRgb pixel(int x, int y) • int pixelIndex(int x, int y) • QRect rect(void) • QImage rgbSwapped(void) • bool save(QString, const char * format, int quality) • QImage scaled(int width, int height, Qt::AspectRatioMode aspectRatioMode, Qt::TransformationMode trans- formMode) • QImage scaledToHeight(int height, Qt::TransformationMode mode ) • QImage scaledToWidth(int width, Qt::TransformationMode mode) • uchar *scanLine(int i) • void setColor(int index, QRgb colorValue) • void setColorCount(int colorCount) • void setDotsPerMeterX(int x) • void setDotsPerMeterY(int y) • void setOffset(QPoint) • void setPixel(int x, int y, uint index_or_rgb) • void setText(QString,QString) • QSize size(void) • void swap(QImage) • QString text(QString) • QStringList textKeys(void) • QImage transformed(QMatrix, Qt::TransformationMode mode) • bool valid(int x, int y) • int width(void) 70.110. QImage Class 775
- 799. Ring Documentation, Release1.4.1 70.111 RingCodeHighlighter Class Parameters : QTextDocument *parent • void setColors(QColor c1,QColor c2,QColor c3,QColor c4,QColor c5) 70.112 QXmlStreamReader Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamReader.html Parameters : void • void addData(QByteArray) • void addData_2(QString) • void addData_3(const char * data) • void addExtraNamespaceDeclaration(QXmlStreamNamespaceDeclaration) • void addExtraNamespaceDeclarations(QXmlStreamNamespaceDeclarations) • bool atEnd(void) • QXmlStreamAttributes attributes(void) • qint64 characterOffset(void) • void clear(void) • qint64 columnNumber(void) • QIODevice *device(void) • QStringRef documentEncoding(void) • QStringRef documentVersion(void) • QStringRef dtdName(void) • QStringRef dtdPublicId(void) • QStringRef dtdSystemId(void) • QXmlStreamEntityDeclarations entityDeclarations(void) • QXmlStreamEntityResolver *entityResolver(void) • Error error(void) • QString errorString(void) • bool hasError(void) • bool isCDATA(void) • bool isCharacters(void) • bool isComment(void) • bool isDTD(void) • bool isEndDocument(void) • bool isEndElement(void) • bool isEntityReference(void) 70.111. RingCodeHighlighter Class 776
- 800. Ring Documentation, Release1.4.1 • bool isProcessingInstruction(void) • bool isStandaloneDocument(void) • bool isStartDocument(void) • bool isStartElement(void) • bool isWhitespace(void) • qint64 lineNumber(void) • QStringRef name(void) • QXmlStreamNamespaceDeclarations namespaceDeclarations(void) • bool namespaceProcessing(void) • QStringRef namespaceUri(void) • QXmlStreamNotationDeclarations notationDeclarations(void) • QStringRef prefix(void) • QStringRef processingInstructionData(void) • QStringRef processingInstructionTarget(void) • QStringRef qualifiedName(void) • void raiseError(QString) • QString readElementText(QXmlStreamReader::ReadElementTextBehaviour) • TokenType readNext(void) • bool readNextStartElement(void) • void setDevice(QIODevice *device) • void setEntityResolver(QXmlStreamEntityResolver *resolver) • void setNamespaceProcessing(bool) • void skipCurrentElement(void) • QStringRef text(void) • QString tokenString(void) • TokenType tokenType(void) 70.113 QXmlStreamWriter Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamWriter.html Parameters : void • bool autoFormatting(void) • int autoFormattingIndent(void) • QTextCodec *codec(void) • QIODevice *device(void) • bool hasError(void) 70.113. QXmlStreamWriter Class 777
- 801. Ring Documentation, Release1.4.1 • void setAutoFormatting(bool enable) • void setAutoFormattingIndent(int spacesOrTabs) • void setCodec(QTextCodec *codec) • void setCodec_2(const char *codecName) • void setDevice(QIODevice *device) • void writeAttribute(QString, QString,QString) • void writeAttribute_2(QString, QString) • void writeAttribute_3(QXmlStreamAttribute) • void writeAttributes(QXmlStreamAttributes) • void writeCDATA(QString text) • void writeCharacters(QString text) • void writeComment(QString text) • void writeCurrentToken(QXmlStreamReader reader) • void writeDTD(QString dtd) • void writeDefaultNamespace(QString namespaceUri) • void writeEmptyElement(QString namespaceUri, QString name) • void writeEmptyElement_2(QString qualifiedName) • void writeEndDocument(void) • void writeEndElement(void) • void writeEntityReference(QString name) • void writeNamespace(QString namespaceUri, QString prefix) • void writeProcessingInstruction(QString target, QString data) • void writeStartDocument(QString version) • void writeStartDocument_2(QString version, bool standalone) • void writeStartDocument_3(void) • void writeStartElement(QString namespaceUri, QString name) • void writeStartElement_2(QString qualifiedName) • void writeTextElement(QString namespaceUri, QString name, QString text) • void writeTextElement_2(QString qualifiedName, QString text) 70.114 QXmlStreamNotationDeclaration Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamNotationDeclaration.html Parameters : void • QStringRef name(void) • QStringRef publicId(void) 70.114. QXmlStreamNotationDeclaration Class 778
- 802. Ring Documentation, Release1.4.1 • QStringRef systemId(void) 70.115 QXmlStreamNamespaceDeclaration Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamNamespaceDeclaration.html Parameters : void • QStringRef namespaceUri(void) • QStringRef prefix(void) 70.116 QXmlStreamEntityResolver Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamEntityResolver.html Parameters : void 70.117 QXmlStreamEntityDeclaration Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamEntityDeclaration.html Parameters : void • QStringRef name(void) • QStringRef notationName(void) • QStringRef publicId(void) • QStringRef systemId(void) • QStringRef value(void) 70.118 QXmlStreamAttributes Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamAttributes.html Parameters : void • void append(QString namespaceUri, QString name, QString value) • void append_2(QString qualifiedName, QString value) • bool hasAttribute(QString qualifiedName) • bool hasAttribute_2(QLatin1String qualifiedName) • bool hasAttribute_3(QString namespaceUri, QString name) • QStringRef value(QString namespaceUri, QString name) • QStringRef value_2(QString namespaceUri, QLatin1String name) • QStringRef value_3(QLatin1String namespaceUri, QLatin1String name) • QStringRef value_4(QString qualifiedName) 70.115. QXmlStreamNamespaceDeclaration Class 779
- 803. Ring Documentation, Release1.4.1 • QStringRef value_5(QLatin1String qualifiedName) 70.119 QXmlStreamAttribute Class C++ Reference : http://doc.qt.io/qt-5/QXmlStreamAttribute.html Parameters : void • bool isDefault(void) • QStringRef name(void) • QStringRef namespaceUri(void) • QStringRef prefix(void) • QStringRef qualifiedName(void) • QStringRef value(void) 70.120 QThread Class C++ Reference : http://doc.qt.io/qt-5/QThread.html Parameters : QObject * Parent Class : QObject • QAbstractEventDispatcher *eventDispatcher(void) • void exit(int returnCode) # In RingQt use : void exitfromthread(int returnCode) • bool isFinished(void) • bool isInterruptionRequested(void) • bool isRunning(void) • QThread::Priority priority(void) • void requestInterruption(void) • void setEventDispatcher(QAbstractEventDispatcher *eventDispatcher) • void setPriority(QThread::Priority priority) • void setStackSize(uint stackSize) • uint stackSize(void) • bool wait(unsigned long time) • void quit(void) • void start(QThread::Priority priority) • void terminate(void) • QThread *currentThread(void) • Qt::HANDLE currentThreadId(void) • int idealThreadCount(void) • void msleep(unsigned long msecs) 70.119. QXmlStreamAttribute Class 780
- 804. Ring Documentation, Release1.4.1 • void sleep(unsigned long secs) • void usleep(unsigned long usecs) • void yieldCurrentThread(void) • void setStartedEvent(const char *) • void setFinishedEvent(const char *) • const char *getStartedEvent(void) • const char *getFinishedEvent(void) 70.121 QThreadPool Class C++ Reference : http://doc.qt.io/qt-5/QThreadPool.html Parameters : void Parent Class : QObject • int activeThreadCount(void) • void clear(void) • int expiryTimeout(void) • int maxThreadCount(void) • void releaseThread(void) • void reserveThread(void) • void setExpiryTimeout(int expiryTimeout) • void setMaxThreadCount(int maxThreadCount) • void start(QRunnable * runnable, int priority) • bool tryStart(QRunnable * runnable) • bool waitForDone(int msecs) • QThreadPool *globalInstance(void) 70.122 QRegularExpression Class C++ Reference : http://doc.qt.io/qt-5/QRegularExpression.html Parameters : void • int captureCount(void) • QString errorString(void) • QRegularExpressionMatchIterator globalMatch(QString subject, int offset, QRegularExpression::MatchType matchType, QRegularExpression::MatchOptions matchOptions) • bool isValid(void) • QRegularExpressionMatch match(QString subject, int offset, QRegularExpression::MatchType matchType, QRegularExpression::MatchOptions matchOptions) 70.121. QThreadPool Class 781
- 805. Ring Documentation, Release1.4.1 • QStringList namedCaptureGroups(void) • QString pattern(void) • int patternErrorOffset(void) • QRegularExpression::PatternOptions patternOptions(void) • void setPattern(QString pattern) • void setPatternOptions(QRegularExpression::PatternOptions options) • void swap(QRegularExpression other) 70.123 QRegularExpressionMatch Class C++ Reference : http://doc.qt.io/qt-5/QRegularExpressionMatch.html Parameters : void • QString captured(int nth) • QString captured_2(const QString name) • int capturedEnd(int nth) • int capturedEnd_2(const QString name) • int capturedLength(int nth) • int capturedLength_2(const QString name) • QStringRef capturedRef(int nth) • QStringRef capturedRef_2(const QString name) • int capturedStart(int nth) • int capturedStart_2(const QString name) • QStringList capturedTexts(void) • bool hasMatch(void) • bool hasPartialMatch(void) • bool isValid(void) • int lastCapturedIndex(void) • QRegularExpression::MatchOptions matchOptions(void) • QRegularExpression::MatchType matchType(void) • QRegularExpression regularExpression(void) • void swap(QRegularExpressionMatch other) 70.124 QRegularExpressionMatchIterator Class C++ Reference : http://doc.qt.io/qt-5/QRegularExpressionMatchIterator.html Parameters : void • bool hasNext(void) 70.123. QRegularExpressionMatch Class 782
- 806. Ring Documentation, Release1.4.1 • bool isValid(void) • QRegularExpression::MatchOptions matchOptions(void) • QRegularExpression::MatchType matchType(void) • QRegularExpressionMatch next(void) # In RingQt use : QRegularExpressionMatch nextitem(void) • QRegularExpressionMatch peekNext(void) • QRegularExpression regularExpression(void) • void swap(QRegularExpressionMatchIterator other) 70.125 QJsonArray Class C++ Reference : http://doc.qt.io/qt-5/QJsonArray.html Parameters : void • void append(QJsonValue value) • QJsonValue at(int i) • bool contains(QJsonValue value) • int count(void) • bool empty(void) • QJsonValue first(void) • void insert(int i, QJsonValue value) • bool isEmpty(void) • QJsonValue last(void) • void pop_back(void) • void pop_front(void) • void prepend(QJsonValue value) • void push_back(QJsonValue value) • void push_front(QJsonValue value) • void removeAt(int i) • void removeFirst(void) • void removeLast(void) • void replace(int i, QJsonValue value) • int size(void) • QJsonValue takeAt(int i) • QVariantList toVariantList(void) • QJsonArray fromStringList(QStringList list) • QJsonArray fromVariantList(QVariantList list) 70.125. QJsonArray Class 783
- 807. Ring Documentation, Release1.4.1 70.126 QJsonDocument Class C++ Reference : http://doc.qt.io/qt-5/QJsonDocument.html Parameters : void • QJsonArray array(void) • bool isArray(void) • bool isEmpty(void) • bool isNull(void) • bool isObject(void) • QJsonObject object(void) • const char * rawData(int * size) • void setArray(QJsonArray array) • void setObject(QJsonObject object) • QByteArray toBinaryData(void) • QByteArray toJson(QJsonDocument::JsonFormat format) • QVariant toVariant(void) • QJsonDocument fromBinaryData( QByteArray data, QJsonDocument::DataValidation validation) • QJsonDocument fromJson( QByteArray json, QJsonParseError * error) • QJsonDocument fromRawData( char * data, int size, QJsonDocument::DataValidation validation) • QJsonDocument fromVariant( QVariant variant) 70.127 QJsonObject Class C++ Reference : http://doc.qt.io/qt-5/QJsonObject.html Parameters : void • bool contains(QString key) • int count(void) • bool empty(void) • bool isEmpty(void) • QStringList keys(void) • int length(void) • void remove(QString key) • int size(void) • QJsonValue take(QString key) • QVariantMap toVariantMap(void) • QJsonValue value(QString key) • QJsonObject fromVariantMap(QVariantMap map) 70.126. QJsonDocument Class 784
- 808. Ring Documentation, Release1.4.1 70.128 QJsonParseError Class C++ Reference : http://doc.qt.io/qt-5/QJsonParseError.html Parameters : void • QString errorString(void) 70.129 QJsonValue Class C++ Reference : http://doc.qt.io/qt-5/QJsonValue.html Parameters : void • bool isArray(void) • bool isBool(void) • bool isDouble(void) • bool isNull(void) • bool isObject(void) • bool isString(void) • bool isUndefined(void) • QJsonArray toArray(QJsonArray defaultValue) • QJsonArray toArray_2(void) • bool toBool(bool defaultValue ) • double toDouble(double defaultValue ) • int toInt(int defaultValue ) • QJsonObject toObject(QJsonObject defaultValue) • QJsonObject toObject_2(void) • QString toString(QString defaultValue ) • QVariant toVariant(void) • QJsonValue::Type type(void) • QJsonValue fromVariant(QVariant variant) 70.130 QPlainTextEdit Class C++ Reference : http://doc.qt.io/qt-5/QPlainTextEdit.html Parameters : QWidget * Parent Class : QAbstractScrollArea • QString anchorAt(QPoint pos) • bool backgroundVisible(void) • int blockCount(void) 70.128. QJsonParseError Class 785
- 809. Ring Documentation, Release1.4.1 • bool canPaste(void) • bool centerOnScroll(void) • QMenu * createStandardContextMenu(void) • QTextCharFormat currentCharFormat(void) • QTextCursor cursorForPosition(QPoint pos) • QRect cursorRect(QTextCursor cursor) • QRect cursorRect_2(void) • int cursorWidth(void) • QTextDocument * document(void) • QString documentTitle(void) • void ensureCursorVisible(void) • QList<QTextEdit::ExtraSelection> extraSelections(void) • bool find(QString exp, QTextDocument::FindFlags options) • bool isReadOnly(void) • bool isUndoRedoEnabled(void) • QPlainTextEdit::LineWrapMode lineWrapMode(void) • int maximumBlockCount(void) • void mergeCurrentCharFormat(QTextCharFormat modifier) • void moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode) • bool overwriteMode(void) • void print(QPagedPaintDevice *printer) • void setBackgroundVisible(bool visible) • void setCenterOnScroll(bool enabled) • void setCurrentCharFormat(QTextCharFormat format) • void setCursorWidth(int width) • void setDocument(QTextDocument *document) • void setDocumentTitle(QString title) • void setExtraSelections(QList<QTextEdit::ExtraSelection> selections) • void setLineWrapMode(QPlainTextEdit::LineWrapMode mode) • void setMaximumBlockCount(int maximum) • void setOverwriteMode(bool overwrite) • void setReadOnly(bool ro) • void setTabChangesFocus(bool b) • void setTabStopWidth(int width) • void setTextCursor(QTextCursor cursor) • void setTextInteractionFlags(Qt::TextInteractionFlags flags) 70.130. QPlainTextEdit Class 786
- 810. Ring Documentation, Release1.4.1 • void setUndoRedoEnabled(bool enable) • void setWordWrapMode(QTextOption::WrapMode policy) • bool tabChangesFocus(void) • int tabStopWidth(void) • QTextCursor textCursor(void) • Qt::TextInteractionFlags textInteractionFlags(void) • QString toPlainText(void) • QTextOption::WrapMode wordWrapMode(void) • void appendHtml(QString html) • void appendPlainText(QString text) • void centerCursor(void) • void clear(void) • void copy(void) • void cut(void) • void insertPlainText(QString text) • void paste(void) • void redo(void) • void selectAll(void) • void setPlainText(QString text) • void undo(void) • void zoomIn(int range) • void zoomOut(int range) • void setblockCountChangedEvent(const char *cStr) • void setcopyAvailableEvent(const char *cStr) • void setcursorPositionChangedEvent(const char *cStr) • void setmodificationChangedEvent(const char *cStr) • void setredoAvailableEvent(const char *cStr) • void setselectionChangedEvent(const char *cStr) • void settextChangedEvent(const char *cStr) • void setundoAvailableEvent(const char *cStr) • void setupdateRequestEvent(const char *cStr) • const char *getblockCountChangedEvent(void) • const char *getcopyAvailableEvent(void) • const char *getcursorPositionChangedEvent(void) • const char *getmodificationChangedEvent(void) • const char *getredoAvailableEvent(void) 70.130. QPlainTextEdit Class 787
- 811. Ring Documentation, Release1.4.1 • const char *getselectionChangedEvent(void) • const char *gettextChangedEvent(void) • const char *getundoAvailableEvent(void) • const char *getupdateRequestEvent(void) • void cyanline(void) • void setactivelinecolor(QColor) 70.131 CodeEditor Class C++ Reference : http://doc.qt.io/qt-5/CodeEditor.html Parameters : QWidget * Parent Class : QPlainTextEdit • void setCompleter(QCompleter *c) • QCompleter *completer(void) • void setLineNumbersAreaColor(QColor oColor) • void setLineNumbersAreaBackColor(QColor oColor) 70.132 QGridLayout Class C++ Reference : http://doc.qt.io/qt-5/QGridLayout.html Parameters : void • void addItem(QLayoutItem * item, int row, int column, int rowSpan , int columnSpan , Qt::Alignment alignment ) • void addLayout(QLayout * layout, int row, int column, Qt::Alignment alignment ) • void addLayout_2(QLayout * layout, int row, int column, int rowSpan, int columnSpan, Qt::Alignment align- ment ) • void addWidget(QWidget * widget, int row, int column, Qt::Alignment alignment ) • void addWidget_2(QWidget * widget, int fromRow, int fromColumn, int rowSpan, int columnSpan, Qt::Alignment alignment ) • QRect cellRect(int row, int column) • int columnCount(void) • int columnMinimumWidth(int column) • int columnStretch(int column) • void getItemPosition(int index, int * row, int * column, int * rowSpan, int * columnSpan) • int horizontalSpacing(void) • QLayoutItem * itemAtPosition(int row, int column) • Qt::Corner originCorner(void) • int rowCount(void) 70.131. CodeEditor Class 788
- 812. Ring Documentation, Release1.4.1 • int rowMinimumHeight(int row) • int rowStretch(int row) • void setColumnMinimumWidth(int column, int minSize) • void setColumnStretch(int column, int stretch) • void setHorizontalSpacing(int spacing) • void setOriginCorner(Qt::Corner corner) • void setRowMinimumHeight(int row, int minSize) • void setRowStretch(int row, int stretch) • void setSpacing(int spacing) • void setVerticalSpacing(int spacing) • int spacing(void) • int verticalSpacing(void) 70.133 QTextCharFormat Class C++ Reference : http://doc.qt.io/qt-5/QTextCharFormat.html Parameters : void • QString anchorHref(void) • QStringList anchorNames(void) • QFont font(void) • QFont::Capitalization fontCapitalization(void) • QString fontFamily(void) • bool fontFixedPitch(void) • QFont::HintingPreference fontHintingPreference(void) • bool fontItalic(void) • bool fontKerning(void) • qreal fontLetterSpacing(void) • QFont::SpacingType fontLetterSpacingType(void) • bool fontOverline(void) • qreal fontPointSize(void) • int fontStretch(void) • bool fontStrikeOut(void) • QFont::StyleHint fontStyleHint(void) • QFont::StyleStrategy fontStyleStrategy(void) • bool fontUnderline(void) • int fontWeight(void) 70.133. QTextCharFormat Class 789
- 813. Ring Documentation, Release1.4.1 • qreal fontWordSpacing(void) • bool isAnchor(void) • bool isValid(void) • void setAnchor(bool anchor) • void setAnchorHref( QString value) • void setAnchorNames( QStringList names) • void setFontCapitalization(QFont::Capitalization capitalization) • void setFontFamily( QString family) • void setFontFixedPitch(bool fixedPitch) • void setFontHintingPreference(QFont::HintingPreference hintingPreference) • void setFontItalic(bool italic) • void setFontKerning(bool enable) • void setFontLetterSpacing(qreal spacing) • void setFontLetterSpacingType(QFont::SpacingType letterSpacingType) • void setFontOverline(bool overline) • void setFontPointSize(qreal size) • void setFontStretch(int factor) • void setFontStrikeOut(bool strikeOut) • void setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy ) • void setFontStyleStrategy(QFont::StyleStrategy strategy) • void setFontUnderline(bool underline) • void setFontWeight(int weight) • void setFontWordSpacing(qreal spacing) • void setTextOutline( QPen pen) • void setToolTip( QString text) • void setUnderlineColor( QColor color) • void setUnderlineStyle(QTextCharFormat::UnderlineStyle style) • void setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment) • QPen textOutline(void) • QString toolTip(void) • QColor underlineColor(void) • QTextCharFormat::UnderlineStyle underlineStyle(void) • QTextCharFormat::VerticalAlignment verticalAlignment(void) 70.133. QTextCharFormat Class 790
- 814. Ring Documentation, Release1.4.1 70.134 QCameraViewfinder Class C++ Reference : http://doc.qt.io/qt-5/QCameraViewfinder.html Parameters : QWidget * Parent Class : QVideoWidget 70.135 QGraphicsVideoItem Class C++ Reference : http://doc.qt.io/qt-5/QGraphicsVideoItem.html Parameters : void • Qt::AspectRatioMode aspectRatioMode(void) • QSizeF nativeSize(void) • QPointF offset(void) • void setAspectRatioMode(Qt::AspectRatioMode mode) • void setOffset(QPointF offset) • void setSize(QSizeF size) • QSizeF size(void) 70.136 QVideoWidgetControl Class C++ Reference : http://doc.qt.io/qt-5/QVideoWidgetControl.html Parent Class : QMediaControl 70.137 QCamera Class C++ Reference : http://doc.qt.io/qt-5/QCamera.html Parameters : void Parent Class : QMediaObject • QCamera::CaptureModes captureMode(void) • QCamera::Error error(void) • QString errorString(void) • QCameraExposure * exposure(void) • QCameraFocus * focus(void) • QCameraImageProcessing * imageProcessing(void) • bool isCaptureModeSupported(QCamera::CaptureModes mode) • QCamera::LockStatus lockStatus(void) • QCamera::LockStatus lockStatus_2(QCamera::LockType lockType) 70.134. QCameraViewfinder Class 791
- 815. Ring Documentation, Release1.4.1 • QCamera::LockTypes requestedLocks(void) • void setViewfinder(QVideoWidget * viewfinder) • void setViewfinder_2(QGraphicsVideoItem * viewfinder) • void setViewfinder_3(QAbstractVideoSurface * surface) • QCamera::State state(void) • QCamera::Status status(void) • QCamera::LockTypes supportedLocks(void) • void load(void) • void searchAndLock(void) • void searchAndLock_2(QCamera::LockTypes locks) • void setCaptureMode(QCamera::CaptureModes mode) • void start(void) • void stop(void) • void unload(void) • void unlock(void) • void unlock_2(QCamera::LockTypes locks) 70.138 QCameraImageCapture Class C++ Reference : http://doc.qt.io/qt-5/QCameraImageCapture.html Parameters : QMediaObject * mediaObject • QMultimedia::AvailabilityStatus availability(void) • QVideoFrame::PixelFormat bufferFormat(void) • QCameraImageCapture::CaptureDestinations captureDestination(void) • QImageEncoderSettings encodingSettings(void) • QCameraImageCapture::Error error(void) • QString errorString(void) • QString imageCodecDescription( QString codec) • bool isAvailable(void) • bool isCaptureDestinationSupported(QCameraImageCapture::CaptureDestinations destination) • bool isReadyForCapture(void) • void setBufferFormat( QVideoFrame::PixelFormat format) • void setCaptureDestination(QCameraImageCapture::CaptureDestinations destination) • void setEncodingSettings( QImageEncoderSettings settings) • QList<QVideoFrame::PixelFormat> supportedBufferFormats(void) • QStringList supportedImageCodecs(void) 70.138. QCameraImageCapture Class 792
- 816. Ring Documentation, Release1.4.1 • QList<QSize> supportedResolutions( QImageEncoderSettings settings , bool * continuous ) • void cancelCapture(void) • int capture( QString file ) 70.139 QMediaObject Class C++ Reference : http://doc.qt.io/qt-5/QMediaObject.html Parameters : void Parent Class : QWidget • QStringList availableMetaData(void) • bool isMetaDataAvailable(void) • QVariant metaData( QString key) • int notifyInterval(void) • void setNotifyInterval(int milliSeconds) 70.140 QHeaderView Class C++ Reference : http://doc.qt.io/qt-5/QHeaderView.html Parameters : Qt::Orientation, QWidget * Parent Class : QAbstractItemView • bool cascadingSectionResizes(void) • int count(void) • Qt::Alignment defaultAlignment(void) • int defaultSectionSize(void) • int hiddenSectionCount(void) • void hideSection(int logicalIndex) • bool highlightSections(void) • bool isSectionHidden(int logicalIndex) • bool isSortIndicatorShown(void) • int length(void) • int logicalIndex(int visualIndex) • int logicalIndexAt(int position) • int logicalIndexAt_2(int x, int y) • int logicalIndexAt_3( QPoint pos) • int maximumSectionSize(void) • int minimumSectionSize_2(void) • void moveSection(int from, int to) 70.139. QMediaObject Class 793
- 817. Ring Documentation, Release1.4.1 • int offset(void) • Qt::Orientation orientation(void) • int resizeContentsPrecision(void) • void resizeSection(int logicalIndex, int size) • void resizeSections(QHeaderView::ResizeMode mode) • bool restoreState( QByteArray state) • QByteArray saveState(void) • int sectionPosition(int logicalIndex) • QHeaderView::ResizeMode sectionResizeMode(int logicalIndex) • int sectionSize(int logicalIndex) • int sectionSizeHint(int logicalIndex) • int sectionViewportPosition(int logicalIndex) • bool sectionsClickable(void) • bool sectionsHidden(void) • bool sectionsMovable(void) • bool sectionsMoved(void) • void setCascadingSectionResizes(bool enable) • void setDefaultAlignment(Qt::Alignment alignment) • void setDefaultSectionSize(int size) • void setHighlightSections(bool highlight) • void setMaximumSectionSize(int size) • void setMinimumSectionSize(int size) • void setResizeContentsPrecision(int precision) • void setSectionHidden(int logicalIndex, bool hide) • void setSectionResizeMode(QHeaderView::ResizeMode mode) • void setSectionResizeMode_2(int logicalIndex, QHeaderView::ResizeMode mode) • void setSectionsClickable(bool clickable) • void setSectionsMovable(bool movable) • void setSortIndicator(int logicalIndex, Qt::SortOrder order) • void setSortIndicatorShown(bool show) • void setStretchLastSection(bool stretch) • void showSection(int logicalIndex) • Qt::SortOrder sortIndicatorOrder(void) • int sortIndicatorSection(void) • bool stretchLastSection(void) • int stretchSectionCount(void) 70.140. QHeaderView Class 794
- 818. Ring Documentation, Release1.4.1 • void swapSections(int first, int second) • int visualIndex(int logicalIndex) • int visualIndexAt(int position) • void headerDataChanged(Qt::Orientation orientation, int logicalFirst, int logicalLast) • void setOffset(int offset) • void setOffsetToLastSection(void) • void setOffsetToSectionPosition(int visualSectionNumber) • void setgeometriesChangedEvent(const char *) • void setsectionClickedEvent(const char *) • void setsectionCountChangedEvent(const char *) • void setsectionDoubleClickedEvent(const char *) • void setsectionEnteredEvent(const char *) • void setsectionHandleDoubleClickedEvent(const char *) • void setsectionMovedEvent(const char *) • void setsectionPressedEvent(const char *) • void setsectionResizedEvent(const char *) • void setsortIndicatorChangedEvent(const char *) • const char *getgeometriesChangedEvent(void) • const char *getsectionClickedEvent(void) • const char *getsectionCountChangedEvent(void) • const char *getsectionDoubleClickedEvent(void) • const char *getsectionEnteredEvent(void) • const char *getsectionHandleDoubleClickedEvent(void) • const char *getsectionMovedEvent(void) • const char *getsectionPressedEvent(void) • const char *getsectionResizedEvent(void) • const char *getsortIndicatorChangedEvent(void) • void geteventparameters(void) 70.141 QFontMetrics Class C++ Reference : http://doc.qt.io/qt-5/QFontMetrics.html Parameters : QFont • int ascent(void) • int averageCharWidth(void) • QRect boundingRect(QChar ch) 70.141. QFontMetrics Class 795
- 819. Ring Documentation, Release1.4.1 • QRect boundingRect_2( QString text) • QRect boundingRect_3(int x, int y, int width, int height, int flags, QString text, int tabStops , int * tabArray ) • QRect boundingRect_4( QRect rect, int flags, QString text, int tabStops , int * tabArray ) • int descent(void) • QString elidedText( QString text, Qt::TextElideMode mode, int width, int flags ) • int height(void) • bool inFont(QChar ch) • bool inFontUcs4(uint character) • int leading(void) • int leftBearing(QChar ch) • int lineSpacing(void) • int lineWidth(void) • int maxWidth(void) • int minLeftBearing(void) • int minRightBearing(void) • int overlinePos(void) • int rightBearing(QChar ch) • QSize size(int flags, QString text, int tabStops , int * tabArray ) • int strikeOutPos(void) • QRect tightBoundingRect( QString text) • int underlinePos(void) • int width( QString text, int len ) • int width_2(QChar ch) • int xHeight(void) 70.142 QSplashScreen Class C++ Reference : http://doc.qt.io/qt-5/QSplashScreen.html Parameters : QPixmap Parent Class : QWidget • void finish(QWidget *mainWin) • QPixmap pixmap(void) • void repaint(void) • void setPixmap(QPixmap pixmap) • void clearMessage(void) • void showMessage(QString message, int alignment ,QColor color) 70.142. QSplashScreen Class 796
- 820. Ring Documentation, Release1.4.1 70.143 QBoxLayout Class C++ Reference : http://doc.qt.io/qt-5/QBoxLayout.html Parameters : QBoxLayout::Direction dir, QWidget *parent Parent Class : QLayout • void addLayout(QLayout * layout, int stretch ) • void addSpacerItem(QSpacerItem * spacerItem) • void addSpacing(int size) • void addStretch(int stretch ) • void addStrut(int size) • void addWidget(QWidget * widget, int stretch , Qt::Alignment alignment ) • QBoxLayout::Direction direction(void) • void insertLayout(int index, QLayout * layout, int stretch ) • void insertSpacerItem(int index, QSpacerItem * spacerItem) • void insertSpacing(int index, int size) • void insertStretch(int index, int stretch ) • void insertWidget(int index, QWidget * widget, int stretch , Qt::Alignment alignment ) • void setDirection(QBoxLayout::Direction direction) • void setSpacing(int spacing) • void setStretch(int index, int stretch) • bool setStretchFactor(QWidget * widget, int stretch) • bool setStretchFactor_2(QLayout * layout, int stretch) • int spacing(void) • int stretch(int index) 70.144 QLayout Class C++ Reference : http://doc.qt.io/qt-5/QLayout.html Parameters : QWidget * Parent Class : QObject • bool activate(void) • void addWidget(QWidget *w) • QMargins contentsMargins(void) • QRect contentsRect(void) • void getContentsMargins(int *left, int *top, int *right, int *bottom) • bool isEnabled(void) • QWidget *menuBar(void) 70.143. QBoxLayout Class 797
- 821. Ring Documentation, Release1.4.1 • QWidget *parentWidget(void) • void removeItem(QLayoutItem *item) • void removeWidget(QWidget *widget) • bool setAlignment(QWidget *w, Qt::Alignment alignment) • void setAlignment_2(Qt::Alignment alignment) • bool setAlignment_3(QLayout *l, Qt::Alignment alignment) • void setContentsMargins(int left, int top, int right, int bottom) • void setContentsMargins_2(QMargins margins) • void setEnabled(bool enable) • void setMenuBar(QWidget *widget) • void setSizeConstraint(QLayout::SizeConstraint) • void setSpacing(int) • QLayout::SizeConstraint sizeConstraint(void) • int spacing(void) • void update(void) • QSize closestAcceptableSize( QWidget * widget, QSize size) 70.145 QLinearGradient Class C++ Reference : http://doc.qt.io/qt-5/QLinearGradient.html Parameters : void Parent Class : QGradient • QPointF finalStop(void) • void setFinalStop(QPointF stop) • void setFinalStop_2(qreal x,qreal y) • void setStart(QPointF start) • void setStart_2(qreal x,qreal y) • QPointF start(void) 70.146 QGradient Class C++ Reference : http://doc.qt.io/qt-5/QGradient.html Parameters : void • QGradient::CoordinateMode coordinateMode(void) • void setColorAt(qreal position, QColor color) • void setCoordinateMode(QGradient::CoordinateMode mode) • void setSpread(QGradient::Spread method) 70.145. QLinearGradient Class 798
- 822. Ring Documentation, Release1.4.1 • void setStops(QGradientStops stopPoints) • QGradient::Spread spread(void) • QGradientStops stops(void) • QGradient::Type type(void) 70.147 QPointF Class C++ Reference : http://doc.qt.io/qt-5/QPointF.html Parameters : void • bool isNull(void) • qreal manhattanLength(void) • qreal rx(void) • qreal ry(void) • void setX(qreal x) • void setY(qreal y) • QPoint toPoint(void) • qreal x(void) • qreal y(void) 70.148 QPoint Class C++ Reference : http://doc.qt.io/qt-5/QPoint.html Parameters : void • bool isNull(void) • int manhattanLength(void) • int rx(void) • int ry(void) • void setX(int x) • void setY(int y) • int x(void) • int y(void) 70.149 QScrollArea Class C++ Reference : http://doc.qt.io/qt-5/QScrollArea.html Parameters : QWidget *parent Parent Class : QAbstractScrollArea 70.147. QPointF Class 799
- 823. Ring Documentation, Release1.4.1 • Qt::Alignment alignment(void) • void ensureVisible(int x, int y, int xmargin , int ymargin ) • void ensureWidgetVisible(QWidget *childWidget, int xmargin , int ymargin ) • void setAlignment(Qt::Alignment) • void setWidget(QWidget *widget) • void setWidgetResizable(bool resizable) • QWidget *takeWidget(void) • QWidget *widget(void) • bool widgetResizable(void) 70.150 QSplitter Class C++ Reference : http://doc.qt.io/qt-5/QSplitter.html Parameters : QWidget *parent Parent Class : QFrame • void addWidget(QWidget *widget) • bool childrenCollapsible(void) • int count(void) • void getRange(int index, int *min, int *max) • QSplitterHandle * handle(int index) • int handleWidth(void) • int indexOf(QWidget *widget) • void insertWidget(int index, QWidget *widget) • bool isCollapsible(int index) • bool opaqueResize(void) • Qt::Orientation orientation(void) • void refresh(void) • bool restoreState( QByteArray state) • QByteArray saveState(void) • void setChildrenCollapsible(bool) • void setCollapsible(int index, bool collapse) • void setHandleWidth(int) • void setOpaqueResize(bool opaque ) • void setOrientation(Qt::Orientation) • void setSizes( QList<int> list) • void setStretchFactor(int index, int stretch) 70.150. QSplitter Class 800
- 824. Ring Documentation, Release1.4.1 • QList<int> sizes(void) • QWidget * widget(int index) 70.151 QCompleter Class C++ Reference : http://doc.qt.io/qt-5/QCompleter.html Parameters : QObject *parent Parent Class : QObject • Qt::CaseSensitivity caseSensitivity(void) • int completionColumn(void) • int completionCount(void) • QCompleter::CompletionMode completionMode(void) • QAbstractItemModel *completionModel(void) • QString completionPrefix(void) • int completionRole(void) • QString currentCompletion(void) • QModelIndex currentIndex(void) • int currentRow(void) • Qt::MatchFlags filterMode(void) • int maxVisibleItems(void) • QAbstractItemModel * model(void) • QCompleter::ModelSorting modelSorting(void) • QAbstractItemView * popup(void) • void setCaseSensitivity(Qt::CaseSensitivity caseSensitivity) • void setCompletionColumn(int column) • void setCompletionMode(QCompleter::CompletionMode mode) • void setCompletionRole(int role) • bool setCurrentRow(int row) • void setFilterMode(Qt::MatchFlags filterMode) • void setMaxVisibleItems(int maxItems) • void setModel(QAbstractItemModel *model) • void setModelSorting(QCompleter::ModelSorting sorting) • void setPopup(QAbstractItemView *popup) • void setWidget(QWidget *widget) • QWidget * widget(void) • bool wrapAround(void) 70.151. QCompleter Class 801
- 825. Ring Documentation, Release1.4.1 • void complete(QRect rect) • void setCompletionPrefix(QString prefix) • void setWrapAround(bool wrap) 70.152 QCompleter2 Class C++ Reference : http://doc.qt.io/qt-5/QCompleter2.html Parameters : QAbstractItemModel *model, QObject *parent Parent Class : QCompleter 70.153 QCompleter3 Class C++ Reference : http://doc.qt.io/qt-5/QCompleter3.html Parameters : QStringList list, QObject *parent Parent Class : QCompleter 70.154 QString2 Class C++ Reference : http://doc.qt.io/qt-5/QString2.html Parameters : void • QString append( QString str) • QStringList split( QString sep, QString::SplitBehavior behavior , Qt::CaseSensitivity cs ) • QStringList split_2(QChar sep, QString::SplitBehavior behavior , Qt::CaseSensitivity cs ) • QStringList split_3( QRegExp rx, QString::SplitBehavior behavior ) • QStringList split_4( QRegularExpression re, QString::SplitBehavior behavior ) 70.155 QProcess Class C++ Reference : http://doc.qt.io/qt-5/QProcess.html Parameters : QObject * Parent Class : QIODevice • QStringList arguments(void) • void closeReadChannel(QProcess::ProcessChannel channel) • void closeWriteChannel(void) • QProcess::ProcessError error(void) • int exitCode(void) • QProcess::ExitStatus exitStatus(void) 70.152. QCompleter2 Class 802
- 826. Ring Documentation, Release1.4.1 • QProcess::InputChannelMode inputChannelMode(void) • QProcess::ProcessChannelMode processChannelMode(void) • QProcessEnvironment processEnvironment(void) • QString program(void) • QByteArray readAllStandardError(void) • QByteArray readAllStandardOutput(void) • QProcess::ProcessChannel readChannel(void) • void setArguments( QStringList arguments) • void setInputChannelMode(QProcess::InputChannelMode mode) • void setProcessChannelMode(QProcess::ProcessChannelMode mode) • void setProcessEnvironment( QProcessEnvironment environment) • void setProgram( QString program) • void setReadChannel(QProcess::ProcessChannel channel) • void setStandardErrorFile( QString fileName, QIODevice::OpenMode mode ) • void setStandardInputFile( QString fileName) • void setStandardOutputFile( QString fileName, QIODevice::OpenMode mode ) • void setStandardOutputProcess(QProcess *destination) • void setWorkingDirectory( QString dir) • void start( QString program, QStringList arguments, QIODevice::OpenMode mode ) • void start_2( QString command, QIODevice::OpenMode mode ) • void start_3(QIODevice::OpenMode mode ) • QProcess::ProcessState state(void) • bool waitForFinished(int msecs ) • bool waitForStarted(int msecs ) • QString workingDirectory(void) • void kill(void) • void terminate(void) • void setreadyReadStandardErrorEvent(const char *) • void setreadyReadStandardOutputEvent(const char *) • const char *getreadyReadStandardErrorEvent(void) • const char *getreadyReadStandardOutputEvent(void) 70.156 QMdiArea Class C++ Reference : http://doc.qt.io/qt-5/QMdiArea.html Parameters : QWidget * 70.156. QMdiArea Class 803
- 827. Ring Documentation, Release1.4.1 Parent Class : QAbstractScrollArea • QMdiArea::WindowOrder activationOrder(void) • QMdiSubWindow * activeSubWindow(void) • QMdiSubWindow * addSubWindow(QWidget * widget, Qt::WindowFlags windowFlags ) • QBrush background(void) • QMdiSubWindow * currentSubWindow(void) • bool documentMode(void) • void removeSubWindow(QWidget * widget) • void setActivationOrder(QMdiArea::WindowOrder order) • void setBackground( QBrush background) • void setDocumentMode(bool enabled) • void setOption(QMdiArea::AreaOption option, bool on ) • void setTabPosition(QTabWidget::TabPosition position) • void setTabShape(QTabWidget::TabShape shape) • void setTabsClosable(bool closable) • void setTabsMovable(bool movable) • void setViewMode(QMdiArea::ViewMode mode) • QList<QMdiSubWindow *> subWindowList(QMdiArea::WindowOrder order ) • QTabWidget::TabPosition tabPosition(void) • QTabWidget::TabShape tabShape(void) • bool tabsClosable(void) • bool tabsMovable(void) • bool testOption(QMdiArea::AreaOption option) • QMdiArea::ViewMode viewMode(void) • void activateNextSubWindow(void) • void activatePreviousSubWindow(void) • void cascadeSubWindows(void) • void closeActiveSubWindow(void) • void closeAllSubWindows(void) • void setActiveSubWindow(QMdiSubWindow * window) • void tileSubWindows(void) 70.157 QMdiSubWindow Class C++ Reference : http://doc.qt.io/qt-5/QMdiSubWindow.html Parameters : QWidget * 70.157. QMdiSubWindow Class 804
- 828. Ring Documentation, Release1.4.1 Parent Class : QWidget • bool isShaded(void) • int keyboardPageStep(void) • int keyboardSingleStep(void) • QMdiArea * mdiArea(void) • void setKeyboardPageStep(int step) • void setKeyboardSingleStep(int step) • void setOption(QMdiSubWindow::SubWindowOption option, bool on ) • void setSystemMenu(QMenu * systemMenu) • void setWidget(QWidget * widget) • QMenu * systemMenu(void) • bool testOption(QMdiSubWindow::SubWindowOption option) • QWidget * widget(void) • void showShaded(void) • void showSystemMenu(void) 70.158 QCursor Class C++ Reference : http://doc.qt.io/qt-5/QCursor.html Parameters : void • QBitmap *bitmap(void) • QPoint hotSpot(void) • QBitmap *mask(void) • QPixmap pixmap(void) • void setShape(Qt::CursorShape shape) • Qt::CursorShape shape(void) 70.159 QListView Class C++ Reference : http://doc.qt.io/qt-5/QListView.html Parameters : QWidget * Parent Class : QAbstractItemView • int batchSize(void) • void clearPropertyFlags(void) • QListView::Flow flow(void) • QSize gridSize(void) • bool isRowHidden(int row) 70.158. QCursor Class 805
- 829. Ring Documentation, Release1.4.1 • bool isSelectionRectVisible(void) • bool isWrapping(void) • QListView::LayoutMode layoutMode(void) • int modelColumn(void) • QListView::Movement movement(void) • QListView::ResizeMode resizeMode(void) • void setBatchSize(int batchSize) • void setFlow(QListView::Flow flow) • void setGridSize( QSize size) • void setLayoutMode(QListView::LayoutMode mode) • void setModelColumn(int column) • void setMovement(QListView::Movement movement) • void setResizeMode(QListView::ResizeMode mode) • void setRowHidden(int row, bool hide) • void setSelectionRectVisible(bool show) • void setSpacing(int space) • void setUniformItemSizes(bool enable) • void setViewMode(QListView::ViewMode mode) • void setWordWrap(bool on) • void setWrapping(bool enable) • int spacing(void) • bool uniformItemSizes(void) • QListView::ViewMode viewMode(void) • bool wordWrap(void) 70.160 QAxObject Class C++ Reference : http://doc.qt.io/qt-5/QAxObject.html Parameters : QString Parent Class : QAxBase 70.161 QAxBase Class C++ Reference : http://doc.qt.io/qt-5/QAxBase.html Parameters : QWidget * Parent Class : QObject • QVariant asVariant(void) 70.160. QAxObject Class 806
- 830. Ring Documentation, Release1.4.1 • QString control(void) • void disableClassInfo(void) • void disableEventSink(void) • void disableMetaObject(void) • QVariant dynamicCall( char *function) • QVariant dynamicCall_2( char *function,QString) • QString generateDocumentation(void) • bool isNull(void) • QAxObject * querySubObject( char *name) • bool setControl( QString ) • QStringList verbs(void) 70.162 QUuid Class C++ Reference : http://doc.qt.io/qt-5/QUuid.html Parameters : void • QString toString(void) 70.163 QToolButton Class C++ Reference : http://doc.qt.io/qt-5/QToolButton.html Parameters : QWidget * Parent Class : QAbstractButton • Qt::ArrowType arrowType(void) • bool autoRaise(void) • QAction * defaultAction(void) • QMenu * menu(void) • QToolButton::ToolButtonPopupMode popupMode(void) • void setArrowType(Qt::ArrowType type) • void setAutoRaise(bool enable) • void setMenu(QMenu * menu) • void setPopupMode(QToolButton::ToolButtonPopupMode mode) • Qt::ToolButtonStyle toolButtonStyle(void) • void setDefaultAction(QAction * action) • void setToolButtonStyle(Qt::ToolButtonStyle style) • void showMenu(void) • void settriggeredEvent(const char *) 70.162. QUuid Class 807
- 831. Ring Documentation, Release1.4.1 • const char *gettriggeredEvent(void) • void setClickEvent(const char *) • const char *getClickEvent(void) 70.164 QSerialPort Class C++ Reference : http://doc.qt.io/qt-5/QSerialPort.html Parameters : QObject * Parent Class : QIODevice • qint32 baudRate(QSerialPort::Directions directions) • bool clear(QSerialPort::Directions directions) • void clearError(void) • QSerialPort::DataBits dataBits(void) • QSerialPort::SerialPortError error(void) • QSerialPort::FlowControl flowControl(void) • bool flush(void) • void *handle(void) • bool isDataTerminalReady(void) • bool isRequestToSend(void) • QSerialPort::Parity parity(void) • QSerialPort::PinoutSignals pinoutSignals(void) • QString portName(void) • qint64 readBufferSize(void) • bool setBaudRate(qint32 baudRate, QSerialPort::Directions directions) • bool setBreakEnabled(bool set) • bool setDataBits(QSerialPort::DataBits dataBits) • bool setDataTerminalReady(bool set) • bool setFlowControl(QSerialPort::FlowControl flowControl) • bool setParity(QSerialPort::Parity parity) • void setPort(QSerialPortInfo serialPortInfo) • void setPortName(QString name) • void setReadBufferSize(qint64 size) • bool setRequestToSend(bool set) • bool setStopBits(QSerialPort::StopBits stopBits) • QSerialPort::StopBits stopBits(void) • void setbaudRateChangedEvent(const char *) 70.164. QSerialPort Class 808
- 832. Ring Documentation, Release1.4.1 • void setbreakEnabledChangedEvent(const char *) • void setdataBitsChangedEvent(const char *) • void setdataTerminalReadyChangedEvent(const char *) • void seterrorEvent(const char *) • void setflowControlChangedEvent(const char *) • void setparityChangedEvent(const char *) • void setrequestToSendChangedEvent(const char *) • void setstopBitsChangedEvent(const char *) • const char *getbaudRateChangedEvent(void) • const char *getbreakEnabledChangedEvent(void) • const char *getdataBitsChangedEvent(void) • const char *getdataTerminalReadyChangedEvent(void) • const char *geterrorEvent(void) • const char *getflowControlChangedEvent(void) • const char *getparityChangedEvent(void) • const char *getrequestToSendChangedEvent(void) • const char *getstopBitsChangedEvent(void) 70.165 QSerialPortInfo Class C++ Reference : http://doc.qt.io/qt-5/QSerialPortInfo.html Parameters : void • QString description(void) • bool hasProductIdentifier(void) • bool hasVendorIdentifier(void) • bool isBusy(void) • bool isNull(void) • QString manufacturer(void) • QString portName(void) • quint16 productIdentifier(void) • void swap(QSerialPortInfo other) • QString systemLocation(void) • quint16 vendorIdentifier(void) 70.165. QSerialPortInfo Class 809
- 833. CHAPTER SEVENTYONE FREQUENTLY ASKED QUESTIONS(FAQ) 71.1 Why do we need Yet Another Programming Language (YAPL)? The language comes with better support for Natural Language Programming and Declarative Programming. The inno- vation comes in supporting these paradigms with new practical techniques on the top of Object-Oriented Programming and Functional Programming. Ring provide the programmers with the tools required to build a Natural Language like Supernova or Declarative Language like REBOL and QML without the need to know anything about (Compilers and Parsing). You get the language constructs ready for use to create domain-specific languages in a fraction of time. Check the Supernova programming language, In this language you can type (I want window and the window title is hello world.) and it will create a GUI window with “Hello, World!” as the window title. When I created Supernova language in 2010. I discovered that using the Natural Code can be (Like English without limits and we can get the human language power in programming) but to implement that You need a new language that are 1. General Purpose 2. Practical 3. Can create Natural Languages very quickly. So we can get a System that can increase ease of use and productivity to the maximum level. Ring is the best language to do that. So I created Ring to achieve this goal. Supernova was just a test for the idea. To get a near view about what are the Advantages and Disadvantages. After testing the new ideas you provide something practical. So we have Ring after Supernova. A story that maybe similar to having Python after ABC. Python avoid ABC problems but bring ABC advantages. Also Ring learn from Ruby and ROR story. The language power could appears in Frameworks better than direct usage as a general purpose language. Also Ring comes with a clear goal/motivation (Creating a new version of the PWCT Software) something learned from designing the C language to create the Unix Operating System. You have a goal that direct you in each design decision. You will understand the value of our decisions once you start trying to solve the problem that we will use Ring to solve. Could you enable any one in the world without knowledge about computer programming concepts to create very powerful software? In science the answer is (Visual Programming) and (Natural Programming). In practical we still away from switching to these paradigms without introducing other problems. Ring is designed to solve this problem. It’s designed to provide Natural Programming in a practical way. And to create a powerful Visual Programming tool. Ring is designed to be a new world of programming after 10 years of research in Visual Programming and Natural Languages. The Ring Programming Language (Compiler+VM) is developed 100% using Visual Programming without writing a single line of code. I used my tool (Programming Without Coding Technology) to design everything and get the C code generated for me. Advantages ? 1. More Faster 2. No Syntax Errors 810
- 834. Ring Documentation, Release1.4.1 3. Easy to understand and manage the code because the Abstraction level is more higher 4. No Critical Disadvantages because you can control everything as writing your code. From my experience in using Visual Programming for 10 years and Natural Programming for 5 years I designed Ring to move the knowledge to mainstream programmers by providing a practical language that support these ideas. I agree that each programmer/developer has the freedom to form his opinions about any software including program- ming languages. Ring is not an exception but you may miss the idea behind the language. It’s innovative and may help you to think different about how to solve your problems. Maybe this is not clear to many programmers because It’s practical language and includes many features known to programmers and when a programmer look at a language he/she may think that nothing new because it’s familiar. I created Ring to solve problems in a different way. Where I will start programming just by describing the software using new natural interfaces that I will implement later when I move from the design stage to the implementation stage. (I don’t determine the time to switch between stages, You are free to use Agile methods). Since Ring is a new language you have 3 options. 1. Just don’t care. 2. Think in the future of the language and help us if you understand the idea and want to contribute. 3. Wait and come back again in the future to use it. Summary: • Ring is designed based on a need to develop a new version of the PWCT software. Once we finish PWCT 2.0 we will have good and large software developed using Ring. • We will push Declarative and Natural paradigms many steps forward. Also in next versions we have a plan to present a new paradigm for Network Programming and Concurrency. We tested this new paradigm through simple prototypes during the last years and we will integrate it with Ring in Future releases. • It’s a new language. A serious ecosystem comes along the way. 71.2 Why Ring is weakly typed? Because it’s more Natural, and Faster and this is important for the language goals. What comes first is what you want. When you type “Print : ” + 5 , The String comes first then 5 will be converted to a String. while when you type 5 + “10” The number comes first so “10” will be converted to 10. This help a lot to quickly convert between numbers and strings using the same operator. If you want to prevent conversion (Write code that prevent conversion) In these cases you will notice that what you are writing is less code (And can be removed). Weakly Typed = Automatic Conversion and Automatic is Good Thing and is better than Manual if you know how to use it correctly. 71.3 What are the advantages to using Ring over Lisp or Smalltalk? Smalltalk and Lisp are GREAT languages. I like many of the concepts behind them but I’m sure that selecting the right programming language is based on the problem and comes after the problem definition. I have a problem that I want to solve and these GREAT languages are not ideal for this problem so I designed Ring. When you design a new language, You can learn from the past but you must look forward and live in the Future. What you know about Natural Programming maybe based on the Old Knowledge about the power of these paradigms in the practical world and I agree with you but I see another techniques that can be applied to get this to work in practical. What you miss about Natural Language is that they are Context Sensitive and this means we can use it and think different about how we can express our ideas. 71.2. Why Ring is weakly typed? 811
- 835. Ring Documentation, Release1.4.1 example : I want window contains 3 buttons. In one sentence I created 4 objects (The window and the three buttons) and added the buttons to the window. The idea of Natural Programming is to get many things done like that. 71.4 Why Ring is largely focussed on UI creation? Yes UI creation is one of the important things in the language features because it’s designed to create a visual pro- gramming tool, But the language is a multi-paradigm language where we can select the programming paradigm based on the problem. 71.5 Is Ring some sort of improvement over PHP? Ring is not designed to replace PHP, Lua and/or Smalltalk. And Ring support for Declarative Programming and Natural Language Programming is very innovative and much better than staying with Procedural, Object-Oriented and Functional Languages. Ring see the future in programming without code (Using Natural Languages) and is designed to support that. 71.6 What are the advantages to using Ring over native C or C++? Ring provides a better way to mix between different programming paradigms in solving problems. The different programming paradigms play well together in the same language. 1. It’s easy to switch from one programming paradigm to another one because the language constructs use similar syntax for similar concepts. 2. The paradigms are provided to interact and used together in different layers in the software. for example you can create a game engine using object-oriented programming but write the game code using declara- tive programming or natural programming and behind the scene your declarative or natural code will use the object- oriented classes. 3. Ring is very productive and natural programming language than C/C++ languages. 4. Ring is a dynamic language. We can generate and execute code during the runtime. We have dynamic typing and weakly typed language for flexibility. 5. The Garbage collector is generational (escape analysis) and also use reference counting. it’s very fast and still provide control to the programmer who can delete memory at any time. 6. Ring Compiler and Virtual Machine is just 15,000 lines of ANSI C code that can be compiled and used in any platform. 7. You can use C/C++ libraries and Ring comes with code generator to create wrappers from C functions or C++ classes. so when you need more performance or when you need to use more libraries you can easily do that. 71.7 What is the difference between Ring and Python? And is Ring Open Source? Yes the language is Free Open Source (MIT license) 71.4. Why Ring is largely focussed on UI creation? 812
- 836. Ring Documentation, Release1.4.1 In general I like Python and Ruby but I was looking for a language more suitable for creating the next version of the Programming Without Coding Technology (PWCT) software so I started the Ring design. Some simple changes that matters for my goal are 1. Not case sensitive 2. The list index start from 1 3. You can call functions before definition 4. Don’t use Python syntax like (indentation, using self, :, pass & _) 5. Weakly typed (convert automatically between types based on context) 6. The programs follow simple and constant structure (Statements then functions then packages and classes) 7. Using the ‘=’ operator for assignment and for testing values Critical changes are 1. Small Language : The Ring compiler + Virtual Machine = 15K lines of C code , the other 85K lines are related to libraries and are optional when we go for using the language in C/C++ programs. 2. The Garbage collector : Uses Escape Analysis/Reference counting and give the programmer the ability to determine when to delete memory using the assignment operator 3. Compact Syntax : Ring is not line sensitive, you don’t need to write ; or press ENTER to separate between statements 4. Using { } to access the object then using the object attributes and methods directly 5. Natural Programming : It’s very easy to create natural interfaces using Ring based on OOP 6. Declarative Programming using Nested Structure The Ring programming language is designed based on my experience from using many other languages like C, C++, C#, Lua, PHP, Python, Ruby, Harbour, Basic and Supernova And the language comes with innovative features added to achieve the language goal • Applications programming language. • Productivity and developing high quality solutions that can scale. • Small and fast language that can be embedded in C/C++ projects. • Simple language that can be used in education and introducing Compiler/VM concepts. • General-Purpose language that can be used for creating domain-specific libraries, frameworks and tools. • Practical language designed for creating the next version of the Programming Without Coding Technology software. 71.8 What are the advantages to using Ring over Perl, PHP, Python or Ruby? 1. Ring is New and Innovative. The language will let you think different about programming. 2. Ring is Smaller. (Lessons learned from the Lua language) 3. Ring is Simple. (Lessons learned from the BASIC and Clipper/Harbour languages) 4. Ring is more Natural. (Lessons learned from the Supernova language) 5. Ring is more Declarative. (Lessons learned from REBOL and QML languages) 71.8. What are the advantages to using Ring over Perl, PHP, Python or Ruby? 813
- 837. Ring Documentation, Release1.4.1 6. Ring Implementation is Transparent, Visual and comes with Rich Features. 71.9 What are the advantages to using Ring over Tcl or Lua? 1. Clean Code (More Natural) 2. More Features (A lot of useful programming paradigms) 71.10 What are the advantages to using Ring over C# or Java? 1. Compact Code (Clean and Natural), More Productivity and Flexibility. 2. Better support for Declarative Programming and Natural Programming 71.11 The documentation says functional programming is sup- ported, but then this happens? The question was about this code f = func { a = 42 return func { return a } } innerF = call f() call innerF() Output: Using uninitialized variable : a In function _ring_anonymous_func_16601() The Answer: • It’s Anonymous Functions, i.e. Not Closures. • Many developers asked about supporting Closures and during language development we may add new features that doesn’t go against the language goals or sprite. • You can use classes and objects when you want to merge between the state and functions to provide a clear solution. • You can use Lists and put the anonymous function inside the List then return the list that contains the state and the function. Pass the list to the function when you use it. • You can use eval() and substr() to add the variable value directly to the anonymous function before return. • We protect you from other scopes when you define the function. In Ring we provided the Three Scopes Rule where at each point you have only at maximum three scopes (Global, Object Scope and Local Scope). • We don’t get everything from everywhere to be like others! We don’t need to do that. If we will think like that then we will create a very complex language or we will save our time and use other languages. • When you think about learning or studying a new language concentrate about (What is new?) and (What is better in this language?) to know when to use it. Don’t compare a new language just released little months ago with languages started many years ago and expect to find everything that you used to have. 71.9. What are the advantages to using Ring over Tcl or Lua? 814
- 838. Ring Documentation, Release1.4.1 • Each programming language miss features in other languages. The idea is not the Features. it’s the sprite and ability behind all of the features together. 71.12 Why the ability to define your own languages Instead of just handing over the syntax so you can parse it using whatever code you like? It’s innovation - You create natural statements without the need to learn about parsing. You just use Classes which is intelligent decision (where later we can mix between classes to support more statements based on the context - We can change and translate the defined statements and many more!). Also the statements are added in Ring World where you can use any Ring statement. 71.13 Why you can specify the number of loops you want to break out of? The language support programming in the small and programming in the large. The selection of what features to use is based on what are you going to do. Any programmer can write bad code in any language if he/she wants to do that. The idea is what must be done from the language design to prevent errors without causing other problems like killing flexibility. Read some source code in the Linux Kernel and Ruby Implementation for example, You will find good usage for GOTO as a practical example that General Rules are not for All Use Cases and great programmers know when to break the rules. I’m not saying go and use GOTO or saying Ring add things like that. But the ability to break more than one loop and/or the ability to break the loop from sub functions is practical for small programs. Anyway these are some of the small new things added by the language (Not the big idea). 71.14 Why Ring uses ‘See’, ‘Give’, ‘But’ and ‘Ok’ Keywords? See and Give are selected not to be “opposite actions” but to reflect what I want to do as a programmer. When I want to see something on the screen I use ‘See’. When I want to give some input to the program I use ‘Give’. My selection of “but” and “ok” is based on selecting keywords that can be written quickly. Also using “but” is easy to remember than elseif/elif/elsif where each language select a different keyword. In Ring 1.1 and later versions All of this is just an option. You can use ‘Put’ and ‘Get’ instead of ‘See’ and ‘Give’ You can use ‘elseif’ and ‘end’ insetad of ‘But’ and ‘Ok’ It’s your choice. In Ring we have syntax flexibility where we provide more than one style. Also you can change the language keywords and operators. Also you can define new natural languages too. 71.12. Why the ability to define your own languages Instead of just handing over the syntax so you can parse it using whatever code you like? 815
- 839. Ring Documentation, Release1.4.1 71.15 What is the philosophy behind data types in Ring? The Ring programming language is designed to be SMALL. The language provides the basic constructs that you need to do anything! One of the goals is to keep the basic constructs simple and small as possible. Using Lists in Ring you can • Create Arrays (one data type) • Create Lists (Mix of data types) • Create Tree (Nested arrays) • Use String Index (Looks like Dictionary/Hash Table) The same principle is applied to Numbers • You can use the number for int value • You can use the number for double value • You can use the number for Boolean value (True/False) The sample principle is applied for Strings • You can use the string for storing one character • You can use the string for storing text (one or many lines) • You can use the string for storing binary data • You can use the string for storing date • You can use the string for storing time • You can use the string for storing NULL values (empty strings) And we have Object Oriented Support + Operator Overloading where the programmer can define new data types and use them as default types defined by the language So We have • A small and simple language that someone can pick in little days • A fast language that provide primitive types (String ? Number ? List ? Object) • A flexible language that can be extended using OOP to add new types according to the application domain 71.16 What about the Boolean values in Ring? You can use true for 1 and false for 0 when you test the result of Boolean expressions in your code. Just when you print the value using the see command you will see 1 for (true) and 0 for (false) Why ? Because Ring contains only 4 types of variables 1. Number 2. String 3. List 71.15. What is the philosophy behind data types in Ring? 816
- 840. Ring Documentation, Release1.4.1 4. Object The first type (Number) is used to represent int, double and Boolean values. The second type (String) is used to represent char, array of characters, date and time. The third type (List) is used to represent Arrays of one type, Arrays of more than one type, Hash (Dictionary), Tree, etc. The object can be an object created from a Ring class (Any Class) or just a C Pointer that we get from calling a C/C++ function/method. Why ? The Ring is designed to give the programmer/developer the most simple constructs that can be used to do everything. The programmer/developer can customize the language by creating new classes (and use operator overloading) to get more types that he care about according to the problem domain. Why ? Because simple is better, and easy to learn and remember! And this provide flexibility to convert between high level types that can be represented using the same basic type 71.17 What is the goal of including the “Main” function in Ring? The main function is very important, you need it when you want to write statements that uses local variables instead of the Global scope. Example: x = 10 myfunc() See "X value = " + X # here I expect that x will be (10) # but I will get another value (6) because myfunc() uses x ! Func myfunc for x = 1 to 5 See x + nl next Output: 1 2 3 4 5 X value = 6 Now using the Main function Func Main x = 10 myfunc() See "X value = " + X Func myfunc for x = 1 to 5 See x + nl next 71.17. What is the goal of including the “Main” function in Ring? 817
- 841. Ring Documentation, Release1.4.1 Output 1 2 3 4 5 X value = 10 71.18 Why the list index start from 1 in Ring? It’s about how we count in the real world, when we have three apples in our hand we say 1 2 3 We don’t start from 0 The question must be why the other languages start from 0 ? The answer is, because this is related to the machine and how we deal with values and memory address. Example we have array called myarray[5] In memory : myarray will have an address The first item will be stored in that address The second item will come after that address and so on Now when we need to point to the first item we need the address of myarray So we type myarray[0] because myarray + 0 result will still point to the first item for the second item myarray[1] because myarray + 1 result will point to the second item and so on In Low Level languages or languages near to the machine it’s good to be like this But for high level language designed for applications it’s better to be natural Example mylist = [1,2,3,4,5] for x = 1 to len(mylist) see x + nl next In the previous example we start from 1 to the length of the array if the index starts from 0 we will write for x = 0 to len(mylist)-1 or remember the for loop in other languages for(x=0 ; x<nMax ; x++ ) You will use the < operator ! 71.19 Is there constructor methods in Ring? When you create new object for example 71.18. Why the list index start from 1 in Ring? 818
- 842. Ring Documentation, Release1.4.1 new point 1 - Ring will allocate dynamic memory space to be used for the new object attributes that Ring doesn’t know anything about them. 2 - Ring will change the current local scope and the current object scope to use the object state created in step (1) 3 - Ring will move the execution to the class Region (After the class name and before any methods) 4 - Any Instructions/Code in the class region will be executed as any Ring code 5 - Control is moved from the class region to the location of (new point) once we reach the end of the class region or we uses a Return command. So All attributes that added to the object are dynamic attributes, this mean that you can control what attributes will be added through the runtime. Example: $3D = False see new point $3D = True see new point class point x y if not $3D return ok z Output: x: NULL y: NULL x: NULL y: NULL z: NULL You have an option to call init() method directly when you create a new object This method can do anything with the object attributes as it will be called after creating the object and executing the class region code. p1 = new point3d(100,200,300) see p1 class point3d x y z func init p1,p2,p3 x=p1 y=p2 z=p3 71.20 What happens when we create a new object? 1- When you create an object, the class region code will be executed and you will have the object attributes based on the code in that region 2- Ring don’t care about the object methods until you start calling a method 3- When you call a method, Ring will check the object class and the class parent (if you are using inheritance) and will collect the methods for you to be used now or later from any object that belong to the same class. 71.20. What happens when we create a new object? 819
- 843. Ring Documentation, Release1.4.1 4- Since methods are dynamic and each object get the method from the class, you can after creating objects, add new methods and use it with the object or any object created or will be created from the same class. Example: o1 = new point {x=10 y=20 z=30} o2 = new point {x=100 y=200 z =300} addmethod(o1,"print", func { see x + nl + y + nl + z + nl } ) o1.print() o2.print() class point x y z Output: 10 20 30 100 200 300 71.21 Can we use the attributes by accessing the Getter and Setter methods? Yes we can, The setter/getter methods are called automatically when you start using the attributes from outside the class Also you can call the methods instead of using the attributes. It’s your choice. Example: o1 = new Developer o1.name = "Mahmoud" see o1.name + nl o1 { name = "Gal" see name } o1 { name = "Bert" see name } o1.setname("Marino") see o1.getname() Class Developer name language = "Ring Programming Language" func setname value see "Message from SetName() Function!" + nl name = value + " - " + language func getname see "Message from GetName() Function!" + nl + nl return "Mr. " + name + nl Output Message from SetName() Function! Message from GetName() Function! 71.21. Can we use the attributes by accessing the Getter and Setter methods? 820
- 844. Ring Documentation, Release1.4.1 Mr. Mahmoud - Ring Programming Language Message from SetName() Function! Message from GetName() Function! Mr. Gal - Ring Programming Language Message from SetName() Function! Message from GetName() Function! Mr. Bert - Ring Programming Language Message from SetName() Function! Message from GetName() Function! Mr. Marino - Ring Programming Language 71.22 Why should a search of global names be made while defining the class attributes? The question is why we don’t avoid conflicts with global variable names when we define the class attributes ? At first remember that using the optional $ mark in the global variables names solve the problem. Also using the Main function and avoiding global variables may help. The Answer: Ring is a dynamic language We can in the run-time determine the class attributes (Add/Remove) We can execute (any code) while defining the class attributes Example (1) oPerson = new Person Class Person See "Welcome to the Ring language" Example (2) Customize attributes based on global variable value $debug = true oPerson = new Person see oPerson Class Person if $debug date=date() time=time() ok In the previous example when we have the $debug flag set to true, we will add the Date and Time attributes to the object state. Example (3) Store the object index based on global variable $ObjectsCount = 0 oPerson = new Person see oPerson oPerson2 = new Person see oPerson2 71.22. Why should a search of global names be made while defining the class attributes? 821
- 845. Ring Documentation, Release1.4.1 Class Person $ObjectsCount++ nIndex = $ObjectsCount Output: nindex: 1.000000 nindex: 2.000000 Common Example: • Connect to the database then get table columns (Using global Variable/Object). • Create class attributes based on the column names. • Later when you modify the database - you may don’t need to modify your code. It’s flexibility but remember that power comes with great responsibility. 71.23 Why Ring doesn’t avoid the conflict between Global Variables and Class Attributes Names? In this use case we have 1 - Global Variable defined without a special mark like $ 2 - Class contains Attributes defined using a special syntax (where we type the attribute name directly after the class) 3 - The Attributes are defined in the class region that allows writing code and using global variables If I will accepted your proposal about changing how Ring find variables in the class region I must break one of the previous three features which will lead to more problems that are more important than this problem. I don’t like changing the feature number (1) because I would like to keep Ring code more clean and let the programmer decide when to use $ or not. I don’t like changing the feature number (2) because I like this feature and I don’t like forcing the programmer to type self.attribute I don’t like changing the feature number (3) because it’s very important in many applications to access global variables in the class region. So what was my decision ? I decided to leave this case for the programmer who will decide what to do to avoid this special case 1 - The programmer can avoid using global variables (Better) and can use the Main function (Optional) 2 - The programmer can use $ before the variable name or any mark like global_ or g_ 3 - The programmer can use self.attribute after the class name to define the attributes In general, for small programs you can use global variables and functions. For large programs, use classes and objects and small number of global variables or avoid them at all. 71.24 Where can I write a program and execute it? Run the Ring Notepad where you can write/execute programs. If you want to run programs using the command line 71.23. Why Ring doesn’t avoid the conflict between Global Variables and Class Attributes Names? 822
- 846. Ring Documentation, Release1.4.1 Add Ring/bin folder to the path then 71.25 How to get the file size using ftell() and fseek() functions? The next function can be used to get the file size without reading the file! func getFileSize fp C_FILESTART = 0 C_FILEEND = 2 fseek(fp,0,C_FILEEND) nFileSize = ftell(fp) fseek(fp,0,C_FILESTART) return nFileSize Note: The previous function take the fp (file pointer) as parameter, We can get the fp from opening the file using fopen() function. fp = fopen("filename","r") see "File Size : " + getFileSize(fp) + nl Another solution (Read the file) see len(read("filename")) 71.26 How to get the current source file path? We can use the next function to get the current source file path then we can add the path variable to the file name cPath = CurrentPath() func currentpath cFileName = filename() for x = len(cFileName) to 1 step -1 if cFileName[x] = "/" return left(cFileName,x-1) ok next return cFileName 71.27 What about predefined parameters or optional parameters in functions? if you want to use predefined parameters or optional parameters Just accept a list that works like hash/dictionary Example sum([ :a = 1, :b = 2]) sum([ :a = 1 ]) sum([ :b = 2 ]) func sum pList if plist[:a] = NULL pList[:a] = 4 ok 71.25. How to get the file size using ftell() and fseek() functions? 823
- 847. Ring Documentation, Release1.4.1 if plist[:b] = NULL pList[:b] = 5 ok see pList[:a] + pList[:b] + nl Output 3 6 6 71.28 How to print keys or values only in List/Dictionary? If you want to print keys only or values only just select the index of the item (one or two). Example C_COUNTRY = 1 C_CITY = 2 mylist = [ :KSA = "Riyadh" , :Egypt = "Cairo" ] for x in mylist see x[C_COUNTRY] + nl next for x in mylist see x[C_CITY] + nl next Output ksa egypt Riyadh Cairo 71.29 Why I get a strange result when printing nl with lists? In the next code list = 1:5 # list = [1,2,3,4,5] see list + nl New Line will be added to the list then the list will be printed, the default print of the lists will print a newline at the end, You added new newline and You have now 2 newlines to be printed. See <Expr> The see command just print the final result of the expression, the expression will be evaluated as it nl = char(13) + char(10) # just a variable that you can change to anything ! The + is an operator 71.28. How to print keys or values only in List/Dictionary? 824
- 848. Ring Documentation, Release1.4.1 string + string ---> new string string + number ---> new string number + number ---> new number number + string ---> new number list + item —> nothing new will be created but the item will be added to the same list Exception number + nl ?> New String This exception is added to easily print numbers then new line. No need for this with printing lists because after printing the last item we already get a new line. 71.30 Could you explain the output of the StrCmp() function? At first remember that you can check strings using ‘=’ operator directly. see strcmp("hello","hello") + nl + strcmp("abc","bcd") + nl + strcmp("bcd","abc") + nl if the two strings are the same then it returns 0 abc and bcd aren’t the same. in the second line it returns -1 and in the third line it returns 1 In the second line we compare between “abc” and “bcd” Not equal because the first letter in “abc” = “a” and the first letter in “bcd” = “b” So we have “a” != “b” and “a” < “b” So we get output = -1 In the third line we have “bcd” and “abc” the first letter in “bcd” is “b” and the first letter in “abc” is “a” So we have “b” != “a” and “b” > “a” So we get output = 1 Note: ASCII(“a”) = 97 and ASCII(“b”) = 98 So “a” < “b” because 97 < 98 71.31 How to use many source code files in the project? Example: I have the next folder C:LRing Contains the next files C:LRingt1.ring C:LRingmylib.ring C:LRinglibsmylib2.ring 71.30. Could you explain the output of the StrCmp() function? 825
- 849. Ring Documentation, Release1.4.1 The file t1.ring contains the next code load "mylib.ring" load "libsmylib2.ring" myfunc() test() The file mylib.ring contains the next code func myfunc see "message from myfunc"+nl The file libsmylib2.ring contains the next code func test see "message from test" + nl from the folder C:LRing If Ring is not added to the path you can add it or use the next command set path=%path%;c:ringbin; Where c:ring is the Ring folder Now run Ring t1.ring Output message from myfunc message from test 71.32 Why this example use the GetChar() twice? The GetChar() function accept one character from the keyboard buffer In this example While True See " Main Menu (1) Say Hello (2) Exit " Option = GetChar() GetChar() GetChar() # End of line # the previous two lines can be replaced with the next line # Give Option if Option = 1 see "Enter your name : " give cName see "Hello " + cName else bye ok End 71.32. Why this example use the GetChar() twice? 826
- 850. Ring Documentation, Release1.4.1 We uses GetChar() Three times The first time we get the user option Option = GetChar() But in the second and the third times (We accept the new line characters from the buffer) GetChar() GetChar() # End of line Example : when the user select the option number 1 then press ENTER We have Three Characters • The first character is : Number 1 • The second character is : CHAR(13) • The third character is : CHAR(10) Because Windows uses CHAR(13) and CHAR(10) for each new line ( i.e. CR+LF ) 71.33 How to use NULL and ISNULL() function? when we try to use uninitialized variable in the Ring programming language, we get a clear runtime error message Example See x Output Line 1 Error (R24) : Using uninitialized variable : x in file testsseeuninit.ring The same happens when you try to access uninitialized attributes Example o1 = new point see o1 see o1.x class point x y z Output x: NULL y: NULL z: NULL Line 3 Error (R24) : Using uninitialized variable : x in file testsseeuninit2.ring if you want to check for the error, just use Try/Catch/End Try see x Catch See "Sorry, We can't use x!" + nl Done Output 71.33. How to use NULL and ISNULL() function? 827
- 851. Ring Documentation, Release1.4.1 Sorry, We can't use x! Now we will talk about NULL and ISNULL() Since we get error message when we deal with uninitialized variables We can check these errors using Try/Catch/Done, So we uses NULL and ISNULL() for dealing with Strings. NULL is a variable contains an empty string ISNULL() is a function that returns true (1) if the input is an empty string or just a string contains “NULL” This because we need to test these values (empty strings) and strings contains “NULL” that sometimes come from external resource like DBMS. Example See IsNull(5) + nl + # print 0 IsNull("hello") + nl + # print 0 IsNull([1,3,5]) + nl + # print 0 IsNull("") + nl + # print 1 IsNull("NULL") # print 1 71.34 How to print lists that contains objects? In this example we will see how we can print a list contains objects. aList = [[1,2,3] , new point(1,2,3), new point(1,2,3)] see "print the list" + nl see alist see "print the item (object)" + nl see alist[2] class point x y z func init p1,p2,p3 x=p1 y=p2 z=p3 Output print the list 1 2 3 x: 1.000000 y: 2.000000 z: 3.000000 x: 1.000000 y: 2.000000 z: 3.000000 print the item (object) x: 1.000000 y: 2.000000 z: 3.000000 71.35 How to insert an item to the first position in the list? To insert an item we can use the insert(aList,nIndex,Value) function. 71.34. How to print lists that contains objects? 828
- 852. Ring Documentation, Release1.4.1 aList = 1:5 insert(aList,0,0) See aList # print numbers from 0 to 5 71.36 How to print new lines and other characters? To print new line we can use the nl variable. See "Hello" + nl or we can use multi-line literal as in the next example See "Hello " if we want to print other characters we can use the char(nASCII) function See char(109) + nl + # print m char(77) # print M 71.37 Why we don’t use () after the qApp class name? When we use RingQt to create GUI application, we uses () after the class name when we create new objects for example. new qWidget() { setWindowTitle("Hello World") resize(400,400) show() } but before doing that we create an object from the qApp class and we don’t use () after that Load "guilib.ring" app = new qApp { win=new qWidget() { setwindowtitle(:test) show() } exec() } Using () after the class name means calling the init() method in the class and passing parameters to this method. If we used () while no init() method in the class we get the expected error message. The class qApp don’t have this method while the other classes have it because they need it to create an object using a function that return a pointer to that object and this pointer will be stored in an attribute called pObject, for more information see ring_qt.ring file which contains the classes. 71.38 Why the window title bar is going outside the screen? When we write the next code 71.36. How to print new lines and other characters? 829
- 853. Ring Documentation, Release1.4.1 Load "guilib.ring" app = new qApp { win=new qWidget() { setwindowtitle(:test) setGeometry(0,0,200,200) show() } exec() } I would expect that the window will run at the point (0,0) with (200,200) size but the actual result is that the window title bar is going outside the screen. This is related to the behavior of Qt framework. The next code will avoid the problem load "guilib.ring" new qApp { new qWidget() { move(0,0) resize(200,200) show() } exec() } 71.39 How to create an array of buttons in GUI applications? Check the next example: Load "guilib.ring" App1 = new qApp { win1 = new qWidget() { move(0,0) resize(500,500) new qPushButton(win1) { settext("OK") setclickevent("click()") } btn1 = new qPushButton(win1) { setgeometry(100,100,100,30) settext("Button1") } btn2 = new qPushButton(win1) { setgeometry(200,100,100,30) settext("Button2") } 71.39. How to create an array of buttons in GUI applications? 830
- 854. Ring Documentation, Release1.4.1 button = [btn1, btn2] show() } exec() } func click button[1] { settext ("Button3") } button[2] { settext ("Button4") } 71.40 How to Close a window then displaying another one? This example demonstrates how to close a window and show another one Load "guilib.ring" app=new qApp { frmBefore=new Qwidget() { setWindowTitle("before!") resize(300,320) move(200,200) button=new qPushButton(frmBefore) { setText("Close") setClickEvent("frmBefore.close() frmMain.show()") } show() } frmMain=new Qwidget() { setWindowTitle("After!") resize(300,320) move(200,200) } exec() } 71.41 How to create a Modal Window? This example demonstrates how to create a modal window load "guilib.ring" app=new qApp { 71.40. How to Close a window then displaying another one? 831
- 855. Ring Documentation, Release1.4.1 frmStart=new Qwidget() { setWindowTitle("The First Window") resize(300,320) move(200,200) button=new qPushButton(frmStart) { setText("Show Modal Window") resize(200,30) setClickEvent("frmModal.show()") } new qPushButton(frmStart) { setText("Close Window") move(0,50) resize(200,30) setClickEvent("frmStart.Close()") } show() } frmModal =new Qwidget() { setWindowTitle("Modal Window") resize(300,320) move(200,200) setparent(frmStart) setwindowmodality(true) setwindowflags(Qt_Dialog) } exec() } Related Documents • http://doc.qt.io/qt-5/qtwidgets-widgets-windowflags-example.html • http://doc.qt.io/qt-5/qt.html#WindowType-enum • http://doc.qt.io/qt-5/qwindow.html#setParent • http://doc.qt.io/qt-5/qt.html#WindowModality-enum 71.42 How can I disable maximize button and resize window? Use the method setWindowFlags() Load "guilib.ring" app1 = new qapp { win1 = new qwidget() { setwindowtitle("First") setgeometry(100,100,500,500) 71.42. How can I disable maximize button and resize window? 832
- 856. Ring Documentation, Release1.4.1 new qpushbutton(win1) { setgeometry(100,100,100,30) settext("close") setclickevent("app1.quit()") } new qpushbutton(win1) { setgeometry(250,100,100,30) settext("Second") setclickevent("second()") } showmaximized() } exec() } func second win2 = new qwidget() { setwindowtitle("Second") setgeometry(100,100,500,500) setwindowflags(Qt_dialog) show() } 71.43 How to use SQLite using ODBC? In Ring 1.1 and later versions we have native support for SQLite, so you don’t need to use it through ODBC. Also we can access SQLite through RingQt. The answer to your question pODBC = odbc_init() odbc_connect(pODBC,"DRIVER=SQLite3 ODBC Driver;Database=mydb.db;LongNames=0;"+ "Timeout=1000;NoTXN=0;SyncPragma=NORMAL;StepAPI=0;") odbc_execute(pODBC,"create table 'tel' ('ID','NAME','PHONE');") odbc_execute(pODBC,"insert into 'tel' values ('1','Mahmoud','123456');") odbc_execute(pODBC,"insert into 'tel' values ('2','Ahmed','123456');") odbc_execute(pODBC,"insert into 'tel' values ('3','Ibrahim','123456');") odbc_execute(pODBC,"select * from tel") + nl nMax = odbc_colcount(pODBC) See "Columns Count : " + nMax + nl while odbc_fetch(pODBC) See nl for x = 1 to nMax see odbc_getdata(pODBC,x) if x != nMax see " - " ok next end odbc_disconnect(pODBC) odbc_close(pODBC) Output: Columns Count : 3 71.43. How to use SQLite using ODBC? 833
- 857. Ring Documentation, Release1.4.1 1 - Mahmoud - 123456 2 - Ahmed - 123456 3 - Ibrahim - 123456 The program will create the file : mydb.db Note : when I print the odbc drivers I see the long list that includes SQLite3 ODBC Driver - UsageCount=1 SQLite ODBC Driver - UsageCount=1 SQLite ODBC (UTF-8) Driver - UsageCount=1 And I’m using “SQLite3 ODBC Driver”. 71.44 Can I connect to dbase/harbour database? You can connect to any database using ODBC To connect to xbase files (*.DBF) See "Using DBF Files using ODBC" + nl pODBC = odbc_init() See "Connect to database" + nl odbc_connect(pODBC,"Driver={Microsoft dBase Driver (*.dbf)};"+ "datasource=dBase Files;DriverID=277") See "Select data" + nl odbc_execute(pODBC,"select * from tel.dbf") nMax = odbc_colcount(pODBC) See "Columns Count : " + nMax + nl while odbc_fetch(pODBC) See "Row data:" + nl for x = 1 to nMax see odbc_getdata(pODBC,x) + " - " next end See "Close database..." + nl odbc_disconnect(pODBC) odbc_close(pODBC) Output Using DBF Files using ODBC Connect to database Select data Columns Count : 3 Row data: Ahmad - Egypt - 234567 - Row data: Fady - Egypt - 345678 - Row data: Shady - Egypt - 456789 - Row data: Mahmoud - Egypt - 123456 - Close database... Also you can connect to a Visual FoxPro database (requires installing Visual FoxPro driver) See "ODBC test 6" + nl pODBC = odbc_init() See "Connect to database" + nl odbc_connect(pODBC,"Driver={Microsoft Visual FoxPro Driver};"+ "SourceType=DBC;SourceDB=C:PWCT19ssbuildPWCTDATACH1Datamydata.dbc;") 71.44. Can I connect to dbase/harbour database? 834
- 858. Ring Documentation, Release1.4.1 See "Select data" + nl see odbc_execute(pODBC,"select * from t38") + nl nMax = odbc_colcount(pODBC) See "Columns Count : " + nMax + nl while odbc_fetch(pODBC) See "Row data:" + nl for x = 1 to nMax see odbc_getdata(pODBC,x) + " - " next end See "Close database..." + nl odbc_disconnect(pODBC) odbc_close(pODBC) 71.45 Why setClickEvent() doesn’t see the object methods directly? setClickEvent(cCode) take a string contains code. The code will be executed when the event happens. Ring support Many Programming Paradigms like Procedural, OOP, Functional and others. But when you support many paradigms at the language level you can’t know which paradigm will be used so you have two options 1. Provide General Solutions that works with many programming paradigms. 2. Provide Many Specific solutions where each one match a specific paradigm. setClickEvent() and others belong to (General Solutions that works with many programming paradigms). You just pass a string of code that will be executed without any care about classes and objects. This code could be anything like calling a function, calling a method and setting variable value. Some other languages force you to use OOP and call methods for events. Also some other languages uses anonymous functions that may get parameters like the current object. Now we have the general solution (not restricted with any paradigm), In the future we may add specific solutions that match specific paradigms (OOP, Functional, Declarative and Natural). 71.46 Why I get Calling Function without definition Error? Each program follow the next order 1 - Loading Files 2 - Global Variables and Statements 3 - Functions 4 - Packages, Classes and Methods So what does that mean ? 1. **** No Functions comes After Classes **** 2. **** No command is required to end functions/methods/classes/packages **** Look at this example See "Hello" test() func test see "message from the test function!" + nl class test 71.45. Why setClickEvent() doesn’t see the object methods directly? 835
- 859. Ring Documentation, Release1.4.1 In the previous example we have a function called test() so we can call it directly using test() In the next example, test() will become a method See"Hello" test() # runtime error message class test func test # Test() now is a method (not a function) see "message from the test method!" + nl The errors comes when you define a method then try calling it directly as a function. The previous program must be See"Hello" new test { test() } # now will call the method class test func test # Test() now is a method (not a function) see "message from the test method!" + nl 71.47 Can Ring work on Windows XP? Ring can work on Windows XP and load extensions without problems. Just be sure that the extension can work on Windows XP and your compiler version support that (modern compilers requires some flags to support XP) Check this topic https://blogs.msdn.microsoft.com/vcblog/2012/10/08/windows-xp-targeting-with-c-in-visual-studio- 2012/ For example, We added /link /SUBSYSTEM:CONSOLE,"5.01" To the batch file to support Windows XP See : https://github.com/ring-lang/ring/blob/master/src/buildvccomplete.bat 71.48 How to extend RingQt and add more classes? You have many options In general you can extend Ring using C or C++ code Ring from Ring code you can call C Functions or use C++ Classes & Methods This chapter in the documentation explains this part in the language http://ring- lang.sourceforge.net/doc/extension.html For example the next code in .c file can be compiled to a DLL file using the Ring library (.lib) #include "ring.h" RING_FUNC(ring_ringlib_dlfunc) { printf("Message from dlfunc"); } 71.47. Can Ring work on Windows XP? 836
- 860. Ring Documentation, Release1.4.1 RING_API void ringlib_init(RingState *pRingState) { ring_vm_funcregister("dlfunc",ring_ringlib_dlfunc); } Then from Ring you can load the DLL file using LoadLib() function then call the C function that called dlfunc() as any Ring function. See "Dynamic DLL" + NL LoadLib("ringlib.dll") dlfunc() Output Dynamic DLL Message from dlfunc When you read the documentation you will know about how to get parameters like (strings, numbers, lists and objects) And how to return a value (any type) from you function. From experience, when we support a C library or C++ Library We discovered that a lot of functions share a lot of code To save our time, and to quickly generate wrappers for C/C++ Libraries to be used in Ring We have this code generator https://github.com/ring-lang/ring/blob/master/extensions/codegen/parsec.ring The code generator is just a Ring program < 1200 lines of Ring code The generator take as input a configuration file contains the C/C++ library information like Functions Prototype, Classes and Methods, Constants, Enum, Structures and members , etc. Then the generator will generate *.C File for C libraries (to be able to use the library functions) *.CPP File for C++ libraries (to be able to use C++ classes and methods) *.Ring File (to be able to use C++ classes as Ring classes) *.RH file (Constants) To understand how the generator work check this extension for the Allegro game programming library https://github.com/ring-lang/ring/tree/master/extensions/ringallegro At first we have the configuration file https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/allegro.cf To write this file, i just used the Allegro documentation + the Ring code generator rules Then after executing the generator using this batch file https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/gencode.bat or using this script https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/gencode.sh I get the generated source code file https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/ring_allegro.c 71.48. How to extend RingQt and add more classes? 837
- 861. Ring Documentation, Release1.4.1 The generated source code file (ring_allegro.c) is around 12,000 Lines of code (12 KLOC) While the configuration file is less than 1 KLOC To build the library (create the DLL files) https://github.com/ring-lang/ring/blob/master/extensions/ringallegro/buildvc.bat Also you can check this extension for the LibSDL Library https://github.com/ring-lang/ring/tree/master/extensions/ringsdl After this know you should know about 1 - Writing the configuration file 2 - Using the Code Generator 3 - Building your library/extension 4 - Using your library/extension from Ring code Let us move now to you question about Qt We have RingQt which is just an extension to ring (ringqt.dll) You don’t need to modify Ring. 1. You just need to modify RingQt 2. Or extend Ring with another extension based on Qt (but the same Qt version) For the first option see the RingQt extension https://github.com/ring-lang/ring/tree/master/extensions/ringqt Configuration file https://github.com/ring-lang/ring/blob/master/extensions/ringqt/qt.cf To generate the source code https://github.com/ring-lang/ring/blob/master/extensions/ringqt/gencode.bat https://github.com/ring-lang/ring/blob/master/extensions/ringqt/gencode.sh https://github.com/ring-lang/ring/blob/master/extensions/ringqt/gencodeandroid.bat To build the DLL/so/Dylib files https://github.com/ring-lang/ring/blob/master/extensions/ringqt/buildmingw32.bat https://github.com/ring-lang/ring/blob/master/extensions/ringqt/buildgcc.sh https://github.com/ring-lang/ring/blob/master/extensions/ringqt/buildclang.sh Study RingQt Learn about the options that you have 1. wrapping a Qt class directly 2. Creating a new class then wrapping your new class For the second option (in the previous two points or in the two points before that) You will create new classes in C++ code Then you merge these classes to RingQt or provide special DLL for them (your decision) If your work is general (will help others) just put it to RingQt. 71.48. How to extend RingQt and add more classes? 838
- 862. Ring Documentation, Release1.4.1 if your work is special (to specific application) just put it in another extension. 71.49 How to add Combobox and other elements to the cells of a QTableWidget? Check the next code Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,1100,370) setwindowtitle("Using QTableWidget") Table1 = new qTableWidget(win1) { setrowcount(10) setcolumncount(10) setGeometry(0,0,800,400) setselectionbehavior(QAbstractItemView_SelectRows) for x = 1 to 10 for y = 1 to 10 item1 = new qtablewidgetitem("R"+X+"C"+Y) setitem(x-1,y-1, item1) next next cmb = new QComboBox(Table1) { alist = ["one","two","three","four","five"] for x in aList additem(x,0) next } setCellWidget(5, 5, cmb) } setcentralwidget(table1) show() } exec() } 71.50 How to perform some manipulations on selected cells in QTableWidget? Check the next sample Load "guilib.ring" New qApp { win1 = new qMainWindow() { setGeometry(100,100,800,600) setwindowtitle("Using QTableWidget") Table1 = new qTableWidget(win1) { setrowcount(10) setcolumncount(10) setGeometry(10,10,400,400) 71.49. How to add Combobox and other elements to the cells of a QTableWidget? 839
- 863. Ring Documentation, Release1.4.1 for x = 1 to 10 for y = 1 to 10 item1 = new qtablewidgetitem("10") setitem(x-1,y-1,item1) next next } btn1 = new qPushButton(win1) { setText("Increase") setGeometry(510,10,100,30) setClickEvent("pClick()") } show() } exec() } func pClick for nRow = 0 to Table1.rowcount() - 1 for nCol = 0 to Table1.columncount() - 1 Table1.item(nRow,nCol) { if isSelected() setText( "" + ( 10 + text()) ) ok } next next 71.50. How to perform some manipulations on selected cells in QTableWidget? 840
- 864. CHAPTER SEVENTYTWO LANGUAGE REFERENCE In thischapter we will learn about • Language keywords • Language Functions • Compiler Errors • Runtime Errors • Language Grammar • Virtual Machine (VM) Instructions 72.1 Language Keywords Keywords Count : 46 • again • and • but • bye • call • case • catch • changeringkeyword • changeringoperator • class • def • do • done • else • elseif • end • exit 841
- 865. Ring Documentation, Release1.4.1 • for • from • func • get • give • if • import • in • load • loadsyntax • loop • new • next • not • off • ok • on • or • other • package • private • put • return • see • step • switch • to • try • while 72.2 Language Functions Functions Count : 233 acos() add() addattribute() adddays() addmethod() ascii() asin() assert() atan() atan2() attributes() binarysearch() callgc() ceil() cfunctions() char() chdir() classes() classname() clearerr() clock() clockspersecond() 72.2. Language Functions 842
- 866. Ring Documentation, Release1.4.1 closelib() copy() cos() cosh() currentdir() date() dec() decimals() decrypt() del() diffdays() dir() download() encrypt() eval() exefilename() exefolder() exp() fabs() fclose() feof() ferror() fexists() fflush() fgetc() fgetpos() fgets() filename() find() floor() fopen() fputc() fputs() fread() freopen() fseek() fsetpos() ftell() functions() fwrite() int2bytes() float2bytes() double2bytes() bytes2int() bytes2float() bytes2double() getattribute() getchar() globals() hex() hex2str() input() insert() intvalue() isalnum() isalpha() isandroid() isattribute() iscfunction() isclass() iscntrl() isdigit() isfreebsd() isfunction() isglobal() isgraph() islinux() islist() islocal() islower() ismacosx() ismethod() ismsdos() isnull() isnumber() isobject() ispackage() ispackageclass() isprint() isprivateattribute() isprivatemethod() ispunct() isspace() isstring() isunix() isupper() iswindows() iswindows64() isxdigit() left() len() lines() list() list2str() loadlib() locals() log() log10() lower() max() md5() mergemethods() methods() min() murmur3hash() mysql_autocommit() mysql_close() mysql_columns() mysql_commit() mysql_connect() mysql_error() mysql_escape_string() mysql_info() mysql_init() mysql_insert_id() mysql_next_result() mysql_query() mysql_result() mysql_result2() mysql_rollback() nullpointer() number() object2pointer() objectid() odbc_autocommit() odbc_close() odbc_colcount() odbc_columns() odbc_commit() odbc_connect() odbc_datasources() odbc_disconnect() odbc_drivers() odbc_execute() odbc_fetch() odbc_getdata() odbc_init() odbc_rollback() odbc_tables() packageclasses() packagename() packages() perror() pointer2object() pow() prevfilename() ptrcmp() raise() randbytes() random() read() remove() rename() reverse() rewind() right() ring_state_init() ring_state_runcode() ring_state_delete() ring_state_runfile() ring_state_findvar() ring_state_newvar() ring_state_runobjectfile() ring_state_main() ringvm_calllist() ringvm_cfunctionslist() ringvm_classeslist() ringvm_fileslist() ringvm_functionslist() ringvm_memorylist() ringvm_packageslist() sendemail() setattribute() sha1() sha224() sha256() sha384() sha512() sin() sinh() sort() space() sqlite_close() sqlite_errmsg() sqlite_execute() sqlite_init() sqlite_open() sqrt() str2hex() str2list() strcmp() string() substr() swap() sysget() system() tan() tanh() tempfile() tempname() time() timelist() trim() type() ungetc() unsigned() upper() varptr() version() windowsnl() 72.3 Compiler Errors • Error (C1) : Error in parameters list, expected identifier • Error (C2) : Error in class name • Error (C3) : Unclosed control strucutre, ‘ok’ is missing 72.3. Compiler Errors 843
- 867. Ring Documentation, Release1.4.1 • Error (C4) : Unclosed control strucutre, ‘end’ is missing • Error (C5) : Unclosed control strucutre, next is missing • Error (C6) : Error in function name • Error (C7) : Error in list items • Error (C8) : Parentheses ‘)’ is missing • Error (C9) : Brackets ‘]’ is missing • Error (C10) : Error in parent class name • Error (C11) : Error in expression operator • Error (C12) :No class definition • Error (C13) : Error in variable name • Error (C14) : Try/Catch miss the Catch keyword! • Error (C15) : Try/Catch miss the Done keyword! • Error (C16) : Error in Switch statement expression! • Error (C17) : Switch statement without OFF • Error (C18) : Missing closing brace for the block opened! • Error (C19) : Numeric Overflow! • Error (C20) : Error in package name • Error (C21) : Unclosed control strucutre, ‘again’ is missing • Error (C22) : Function redefinition, function is already defined! • Error (C23) : Using ‘(‘ after number! • Error (C24) : The parent class name is identical to the subclass name • Error (C25) : Trying to access the self reference after the object name” 72.4 Runtime Errors • Error (R1) : Cann’t divide by zero ! • Error (R2) : Array Access (Index out of range) ! • Error (R3) : Calling Function without definition ! • Error (R4) : Stack Overflow ! • Error (R5) : Can’t access the list item, Object is not list ! • Error (R6) : Variable is required • Error (R7) : Can’t assign to a string letter more than one character • Error (R8) : Variable is not a string • Error (R9) : Using exit command outside loops • Error (R10) : Using exit command with number outside the range • Error (R11) : error in class name, class not found! 72.4. Runtime Errors 844
- 868. Ring Documentation, Release1.4.1 • Error (R12) : error in property name, property not found! • Error (R13) : Object is required • Error (R14) : Calling Method without definition ! • Error (R15) : error in parent class name, class not found! • Error (R16) : Using braces to access unknown object ! • Error (R17) : error, using ‘Super’ without parent class! • Error (R18) : Numeric Overflow! • Error (R19) : Calling function with less number of parameters! • Error (R20) : Calling function with extra number of parameters! • Error (R21) : Using operator with values of incorrect type • Error (R22) : Using loop command outside loops • Error (R23) : Using loop command with number outside the range • Error (R24) : Using uninitialized variable • Error (R25) : Error in package name, Package not found! • Error (R26) : Calling private method from outside the class • Error (R27) : Using private attribute from outside the class • Error (R28) : Using bad data type as step value • Error (R29) : Using bad data type in for loop • Error (R30) : parent class name is identical to child class name • Error (R31) : Trying to destory the object using the self reference • Error (R32) : The CALL command expect a variable contains string! • Error (R33) : Bad decimals number (correct range >= 0 and <=14) ! • Error (R34) : Variable is required for the assignment operation • Error (R35) : Can’t create/open the file! • Error (R36) : The column number is not correct! It’s greater than the number of columns in the list 72.5 Language Grammar Program —> {statement} Statement —> ‘package’ <Identifier> { ‘.’ <Identifier> } Statement —> ‘class’ <Identifier> [ ‘from’|’:’|’<’ <Identifier> ] Statement —> ‘func’|’def’ <Identifier> [ParaList] Statement —> ‘import’ <Identifier> { ‘.’ <Identifier> } Statement —> ‘private’ Statement —> ‘load’ <Literal> Statement —> ‘loadsyntax’ <Literal> 72.5. Language Grammar 845
- 869. Ring Documentation, Release1.4.1 Statement —> ‘changeringkeyword’ <OldKeyword> <NewKeyword> Statement —> ‘changeringoperator’ <OldOperator> <NewOperator> Statement —> ‘see’|’put’ <Expr> Statement —> ‘give’|’get’ <Identifier> Statement —> ‘if’ <Expr> [’{‘] {statement} [ {‘but’|’elseif’ <Expr> {Statement} } ] [’else’ {Statement} ] ‘ok’|’end’|’}’ Statement —> ‘Switch’ <Expr> [’{‘] { ‘on’|’case’ <Expr> {statement} } [’other’ {Statement} ] ‘off’|’end’|’}’ Statement —> ‘for’ <Identifier> ‘=’ <Expr> ‘to’ <Expr> [ ‘step’ <Expr> ] [’{‘] {Statement} ‘next’|’end’|’}’ Statement —> ‘for’ <Identifier> ‘in’ <Expr> [ ‘step’ <Expr> ] [’{‘] {statement} ‘next’|’end’|’}’ Statement —> ‘while’ <Expr> [’{‘] {statement} ‘end’|’}’ Statement —> ‘do’ {statement} ‘again’ <Expr> Statement —> ‘try’ {statement} [’{‘] ‘catch’ {statement} ‘done’|’end’|’}’ Statement —> ‘return’ <Expr> Statement —> ‘bye’ Statement —> ‘exit’ Statement —> ‘loop’ Statement —> <Expr> Statement —> epslion ParaList —> epslion ParaList —> [’(‘] <Identifier> [{ ‘,’ <Identifier> }] [’)’] Expr —> <LogicNot> [{ ‘and’|’or’ <LogicNot> }] LogicNot –> [’not’] <EqualOrNot> EqualOrNot –> [ ‘=’|’!=’ ] <Compare> Compare —> <BitOrXor> [ { ‘<’ | ‘>’ | ‘<=’ | ‘>=’ <BitOrXor> } ] BitOrXor —> <BitAnd> [ { ‘|’ | ‘^’ <BitAnd> } ] BitAnd —> <BitShift> [ { ‘&’ <BitShift> } ] BitShift —> <Arithmetic> [ { ‘<<’ | ‘>>’ <Arithmetic> } ] Arithmetic —> <Term> [ { ‘+’ | ‘-‘ <Term> } ] Term —> <Range> [ { ‘*’ | ‘/’ | ‘%’ <Range> } ] Range —> <Factor> [ ‘:’ <Factor> ] Factor —> <Identifier> [ {Mixer} ] [ ‘=’ <Expr> ] Factor —> <Number> Factor —> <Literal> Factor —> ‘:’ <Identifier> Factor —> ‘-‘ <Expr> Factor —> ‘(‘ <Expr> ‘)’ 72.5. Language Grammar 846
- 870. Ring Documentation, Release1.4.1 Factor —> <List> Factor —> ‘new’ <Identifier> Factor —> <AnonymousFunction> Factor —> ‘call’ <identifier> { ‘.’ <Identifier> } ‘(‘ <Parameters> ‘)’ List —> ‘[’ [ <Expr> { ‘,’ <Expr> } ] ‘]’ Mixer —> { ‘.’ <Identifier> } Mixer —> ‘[’ <Expr> ‘]’ Mixer —> ‘(‘ [ <Expr> [ { ‘,’ <Expr> }] ] ‘)’ Mixer —> ‘{‘ {Statement} ‘}’ AnonymousFunction —> ‘func’|’def’| [<ParaList>] ‘{‘ {Statement} ‘}’ 72.6 Virtual Machine (VM) Instructions Definitions :- • VM : Virtual Machine • Stack : VM Stack • IR : Instruction Register • PC : Program Counter • VP : Variable Pointer • Stack[nSize] : Last Item in the Stack (Last In - First Out) • VV : Variable Value (We have a Pointer to a variable, And we access this variable value) (Stack and Variables) 72.6. Virtual Machine (VM) Instructions 847
- 871. Ring Documentation, Release1.4.1 Operation Description • ICO_PUSHC Add string from the IR to the stack • ICO_PUSHN Add number from the IR to the stack • ICO_PUSHV Replace VP in the stack[nSize] with the variable value • ICO_LOADADDRESS Read variable name from the IR, push VP to the stack • ICO_ASSIGNMENT Stack[nSize-1] VV = Stack[nSize] VV , POP Stack[nSize] • ICO_INC Increment Number in Stack[nSize] by 1 • ICO_LOADAPUSHV The same as ICO_LOADADDRESS then ICO_PUSHV • ICO_NEWLINE Store new line number (debug info) • ICO_FREESTACK Remove all items from the stack , nSize = 0 • ICO_FILENAME Store the source code file name (debug info) • ICO_FREELOADASCOPE Free the Scope List of the current Expression (Jump) Operation Description • ICO_JUMP Set PC to new value from the IR • ICO_JUMPZERO If Stack[nSize] is a number = 0 then Set PC to new value from the IR • ICO_JUMPFOR End of for loop • ICO_JUMPONE If Stack[nSize] is a number = 1 then Set PC to new value from the IR • ICO_JUMPZERO2 As ICO_JUMPZERO but add 1 to the stack (required for many ‘AND’ conditions) • ICO_JUMPONE2 As ICO_JUMPONE but add 1 to the stack (required for many ‘OR’ conditions) (Compare) 72.6. Virtual Machine (VM) Instructions 848
- 872. Ring Documentation, Release1.4.1 Operation Description • ICO_LESSEQUAL If stack[nSize-1] <= stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_EQUAL If stack[nSize-1] = stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_LESS If stack[nSize-1] < stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_GREATER If stack[nSize-1] > stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_GREATEREQUAL If stack[nSize-1] >= stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 • ICO_NOTEQUAL If stack[nSize-1] != stack[nSize] , POP stack[nSize], set Stack[nSize-1] = 1 else set Stack[nSize-1] = 0 (Math) Operation Description • ICO_SUM Stack[nSize-1] = Stack[nSize-1] + Stack[nSize] , POP stack[nSize] • ICO_SUB Stack[nSize-1] = Stack[nSize-1] - Stack[nSize] , POP stack[nSize] • ICO_MUL Stack[nSize-1] = Stack[nSize-1] * Stack[nSize] , POP stack[nSize] • ICO_DIV Stack[nSize-1] = Stack[nSize-1] / Stack[nSize] , POP stack[nSize] • ICO_MOD Stack[nSize-1] = Stack[nSize-1] % Stack[nSize] , POP stack[nSize] • ICO_NEG Stack[nSize] = - Stack[nSize-1] • ICO_PLUSPLUS Stack[nSize] = Stack[nSize] + 1 • ICO_MINUSMINUS Stack[nSize] = Stack[nSize] - 1 (Logic) Operation Description • ICO_AND Stack[nSize-1] = Stack[nSize-1] && Stack[nSize] , POP stack[nSize] • ICO_OR Stack[nSize-1] = Stack[nSize-1] || Stack[nSize] , POP stack[nSize] • ICO_NOT Stack[nSize] = ! Stack[nSize] (Lists) 72.6. Virtual Machine (VM) Instructions 849
- 873. Ring Documentation, Release1.4.1 Operation Description • ICO_LISTSTART Start New List in Temp. Memory • ICO_LISTITEM Add List Item • ICO_LISTEND End List • ICO_LOADINDEXADDRESS Stack[nSize-1] = Stack[nSize-1] VV [ Stack[nSize] ] , POP stack[nSize] (Functions) Operation Description • ICO_LOADFUNC Find function • ICO_CALL Call function • ICO_RETURN Return from function • ICO_RETNULL Return NULl from function • ICO_RETFROMEVAL Return after eval() • ICO_RETITEMREF Return the list item reference - not the value • ICO_NEWFUNC Start new function • ICO_BLOCKFLAG Flag to determine where to jump later (after ICO_RETURN) • ICO_FUNCEXE Start executing function • ICO_ENDFUNCEXE End function execution • ICO_ANONYMOUS Anonymous function (User Interface) Operation Description • ICO_PRINT Print value to the standard output • ICO_GIVE Get input from the keyboard (End Program/Loop) 72.6. Virtual Machine (VM) Instructions 850
- 874. Ring Documentation, Release1.4.1 Operation Description • ICO_BYE End execution of VM • ICO_EXITMARK Place to exit to from a loop • ICO_POPEXITMARK Remove exit mark • ICO_EXIT Break from one loop or more • ICO_LOOP Continue to next loop (For Better Performance) Operation Description • ICO_PUSHP Push pointer to the stack • ICO_INCP Increment variable value using pointer • ICO_PUSHPV Push value of variable using variable pointer • ICO_INCJUMP Increment then jump • ICO_INCPJUMP Increment using pointer then jump • ICO_JUMPVARLENUM Jump if variable value is <= numeric value • ICO_JUMPVARPLENUM Jump if variable value (using pointer) <= numeric value • ICO_LOADFUNCP Push function pointer • ICO_PUSHPLOCAL Push pointer to local variable • ICO_INCLPJUMP Increment value using pointer to local variable then jump • ICO_JUMPVARLPLENUM Jump if the variable value (using pointer) <= numeric value • ICO_INCPJUMPSTEP1 Increment value using variable pointer then jump (for loop step = 1) • ICO_JUMPVARPLENUMSTEP1 Increment value using variable pointer then jump (for loop step = 1) (Try-Catch-Done) 72.6. Virtual Machine (VM) Instructions 851
- 875. Ring Documentation, Release1.4.1 Operation Description • ICO_TRY Start try region • ICO_DONE End try region (Duplicate and Range) Operation Description • ICO_DUPLICATE Duplicate stack value • ICO_RANGE Create list from value to value (OOP) Operation Description • ICO_NEWOBJ Create new object, get class name from the IR, push ob- ject pointer to the stack. • ICO_SETSCOPE Called after creating new object, set the active scope to be the object scope. • ICO_LOADSUBADDRESS Get object attribute, push the pointer to the stack. • ICO_LOADMETHOD Find object method • ICO_AFTERCALLMETHOD Used after calling a method - normal case • ICO_AFTERCALLMETHOD2 Used after calling a method - second case • ICO_NEWCLASS Start new class region • ICO_BRACESTART Open brace • ICO_BRACEEND End brace • ICO_IMPORT Import package • ICO_PRIVATE start private attributes region • ICO_SETPROPERTY set attribute value - check for setter. • ICO_CALLCLASSINIT call call init() method. (Other) 72.6. Virtual Machine (VM) Instructions 852
- 876. Ring Documentation, Release1.4.1 Operation Description • ICO_SETREFERENCE Copy by reference • ICO_KILLREFERENCE Remove reference • ICO_ASSIGNMENTPOINTER Determine the left side variable • ICO_BEFOREEQUAL Determine operators like += , -= , ... etc (Bitwise Operators) Operation Description • ICO_BITAND Stack[nSize-1] = Stack[nSize-1] & Stack[nSize] , POP stack[nSize] • ICO_BITOR Stack[nSize-1] = Stack[nSize-1] | Stack[nSize] , POP stack[nSize] • ICO_BITXOR Stack[nSize-1] = Stack[nSize-1] ^ Stack[nSize] , POP stack[nSize] • ICO_BITNOT Stack[nSize] = ! Stack[nSize] • ICO_BITSHL Stack[nSize-1] = Stack[nSize-1] << Stack[nSize] , POP stack[nSize] • ICO_BITSHR Stack[nSize-1] = Stack[nSize-1] >> Stack[nSize] , POP stack[nSize] (For Step) Operation Description • ICO_STEPNUMBER Determine step number in for loop • ICO_POPSTEP POP step number from steps stack • ICO_LOADAFIRST Load the first address of variable name 72.6. Virtual Machine (VM) Instructions 853
- 877. CHAPTER SEVENTYTHREE RESOURCES In this sectionyou will find resources about the language 73.1 Ring Language Website For news about the language check the website http://ring-lang.net http://ring-lang.sf.net 73.2 Ring Group For questions use the Ring Group (English) https://groups.google.com/forum/#!forum/ring-lang 73.3 Contact the Authors Name : Eng. Mahmoud Samir Fayed Country : Egypt Email : msfclipper@yahoo.com Facebook : https://facebook.com/mahmoudfayed1986 LinkedIn : https://sa.linkedin.com/in/mahmoudfayed1986 Name : D