The Ring programming language version 1.10 book - Part 92 of 212

Ring Documentation, Release 1.10
],
:ubunturingfolderfiles = [
],
:fedoraringfolderfiles = [
],
:macosringfolderfiles = [
],
:run = "ring main.ring",
:windowsrun = "",
:linuxrun = "",
:macosrun = "",
:ubunturun = "",
:fedorarun = "",
:setup = "",
:windowssetup = "",
:linuxsetup = "",
:macossetup = "",
:ubuntusetup = "",
:fedorasetup = "",
:remove = "",
:windowsremove = "",
:linuxremove = "",
:macosremove = "",
:ubunturemove = "",
:fedoraremove = ""
]
78.11 The Package Description File
The package description file contains the package information defined in the list aPackageInfo
Attribute Description
Name Package Name
Description Package Desciption
Folder The Folder Name (Will be created in ring/ringpm/packages)
Developer The Package Developer Name
Email The Package Developer Email
License The Package License
Version The Current Version of the Package (Latest Release)
RingVersion The Required Ring Language Version (Minimum Version)
Versions List of different versions provided by different branches in the GitHub project
Libs List of dependencies (Defined by name, version & GitHub user name)
Files List of files (will be installed in ring/ringpm/packages/[Folder]
RingFolderFiles List of files (will be installed in ring folder)
WindowsFiles Like (Files) but for Microsoft Windows Only
LinuxFiles Like (Files) but for Linux Only
MacOSFiles Like (Files) but for macOS Only
UbuntuFiles Like (Files) but for Ubuntu Only
FedoraFiles Like (Files) but for Fedora Only
Continued on next page
78.11. The Package Description File 878

Table 78.1 – continued from previous page
Attribute Description
WindowsRingFolderFiles Like (RingFolderFiles) but for Microsoft Windows Only
LinuxRingFolderFiles Like (RingFolderFiles) but for Linux Only
MacOSRingFolderFiles Like (RingFolderFiles) but for macOS Only
UbuntuRingFolderFiles Like (RingFolderFiles) but for Ubuntu Only
FedoraRingFolderFiles Like (RingFolderFiles) but for Fedora Only
Run System Command (Command prompt or Terminal) to run the package
WindowsRun Like (Run) but for Microsoft Windows Only
LinuxRun Like (Run) but for Linux Only
MacOSRun Like (Run) but for macOS Only
UbuntuRun Like (Run) but for Ubuntu Only
FedoraRun Like (Run) but for Fedora Only
Setup System Command (Command prompt or Terminal) after downloading the package files
WindowsSetup Like (Setup) but for Microsoft Windows Only
LinuxSetup Like (Setup) but for Linux Only
MacOSSetup Like (Setup) but for macOS Only
UbuntuSetup Like (Setup) but for Ubuntu Only
FedoraSetup Like (Setup) but for Fedora Only
Remove System Command (Command prompt or Terminal) before removing the package files
WindowsRemove Like (Remove) but for Microsoft Windows Only
LinuxRemove Like (Remove) but for Linux Only
MacOSRemove Like (Remove) but for macOS Only
UbuntuRemove Like (Remove) but for Ubuntu Only
FedoraRemove Like (Remove) but for Fedora Only
78.12 Create Package in the Current Folder
To create a package for an application that already exists, go to the application folder then type
ringpm package
This will create the package definition file (package.ring) and will add all of the application files to the package
definition.
Each RingPM package contains the package definition file (package.ring)
The package definition file is a list that describe the package information and files.
Example :
The package definition file for the Ring Notepad package
aPackageInfo = [
:name = "The RingNotepad Package",
:description = "Our RingNotepad package using the Ring programming language",
:folder = "ringnotepad",
:developer = "Mahmoud Fayed",
:email = "msfclipper@yahoo.com",
:license = "MIT License",
:version = "1.0.0",
:ringversion = "1.10",
:versions = [
[
78.12. Create Package in the Current Folder 879

:version = "1.0.0",
:branch = "master"
]
],
:libs = [
[
:name = "stdlib",
:version = "1.0",
:providerusername = ""
],
[
:name = "ringqt",
:version = "1.0",
],
[
:name = "findinfiles",
:version = "1.0",
],
[
:name = "formdesigner",
:version = "1.0",
],
[
:name = "libdepwin_apache",
:version = "1.0",
]
],
:files = [
"main.ring",
"README.md"
],
:ringfolderfiles = [
"applications/rnote/batch/killwebserver.bat",
"applications/rnote/batch/run.bat",
"applications/rnote/batch/run2.bat",
"applications/rnote/image/back.jpg",
"applications/rnote/image/back2.jpg",
"applications/rnote/image/close.png",
"applications/rnote/image/colors.png",
"applications/rnote/image/copy.png",
"applications/rnote/image/cut.png",
"applications/rnote/image/debug.png",
"applications/rnote/image/font.png",
"applications/rnote/image/formdesigner.png",
"applications/rnote/image/new.png",
"applications/rnote/image/notepad.png",
"applications/rnote/image/open.png",
"applications/rnote/image/paste.png",
"applications/rnote/image/print.png",
"applications/rnote/image/project.png",
"applications/rnote/image/richtext.png",
"applications/rnote/image/run.png",
"applications/rnote/image/rungui.png",
"applications/rnote/image/save.png",
78.12. Create Package in the Current Folder 880

"applications/rnote/image/saveas.png",
"applications/rnote/image/search.png",
"applications/rnote/image/source.png",
"applications/rnote/image/undo.png",
"applications/rnote/image/web.png",
"applications/rnote/README.md",
"applications/rnote/rnote.ring",
"applications/rnote/rnoteactivefile.ring",
"applications/rnote/rnoteactivefolder.ring",
"applications/rnote/rnoteautocomplete.ring",
"applications/rnote/rnotebase.ring",
"applications/rnote/rnotecontroller.ring",
"applications/rnote/rnotedistribute.ring",
"applications/rnote/rnoteeditmenu.ring",
"applications/rnote/rnoteeditorevents.ring",
"applications/rnote/rnotefilemenu.ring",
"applications/rnote/rnotefiles.ring",
"applications/rnote/rnotefilestabs.ring",
"applications/rnote/rnotefind.ring",
"applications/rnote/rnotefindinfiles.ring",
"applications/rnote/rnoteformdesigner.ring",
"applications/rnote/rnotegoto.ring",
"applications/rnote/rnotehelp.ring",
"applications/rnote/rnotelists.ring",
"applications/rnote/rnotemainfiletoolbar.ring",
"applications/rnote/rnotemainwindow.ring",
"applications/rnote/rnotemode.ring",
"applications/rnote/rnoteoutputwindow.ring",
"applications/rnote/rnoteprogrammenu.ring",
"applications/rnote/rnoterun.ring",
"applications/rnote/rnotesettings.ring",
"applications/rnote/rnotestyle.ring",
"applications/rnote/rnotetabwidth.ring",
"applications/rnote/rnotetools.ring",
"applications/rnote/rnotetreeviewevents.ring",
"applications/rnote/rnoteviewmenu.ring",
"applications/rnote/rnotewebbrowser.ring"
],
:run = "ring main.ring"
]
78.13 The RingPM Registry File
The RingPM Registry is a local copy of all registred packages.
aPackagesRegistry = [
[ :name = "ringpresentation",
:description = "Powerpoint presentation for the Ring programming language",
:ProviderUserName = "ringpackages"
]
# ...
]
Each package is deﬁned using a list that determine
• Package Name
78.13. The RingPM Registry File 881

• Package Description
• Provider User Name (GitHub User Name)
We can register new packages by updating the registry ﬁle then sending a Pull Request
URL : https://github.com/ring-lang/ring/blob/master/ringpm/registry/registry.ring
78.13. The RingPM Registry File 882

CHAPTER
SEVENTYNINE
LOW LEVEL FUNCTIONS
In this chapter we will learn about the low level functions provided by Ring
• callgc()
• varptr()
• space()
• nullpointer()
• object2pointer()
• pointer2object()
• ispointer()
• ptrcmp()
• ringvm_cfunctionslist()
• ringvm_functionslist()
• ringvm_classeslist()
• ringvm_packageslist()
• ringvm_memorylist()
• ringvm_calllist()
• ringvm_ﬁleslist()
• ringvm_settrace()
• ringvm_tracedata()
• ringvm_traceevent()
• ringvm_tracefunc()
• ringvm_scopescount()
• ringvm_evalinscope()
• ringvm_passerror()
• ringvm_hideerrorMsg()
• ringvm_callfunc()
• ringvm_see()
• ringvm_give()
883

• ringvm_info()
79.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 ﬂy when you call functions.
Example
While True
# process events
# call functions using temp. lists like myfunc(["temp list"])
# call the garbage collector
callgc()
End
Tip: In Ring the garbage collector works automatically in the end of function execution or when you use the assign-
ment statement.
79.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)
79.1. callgc() function 884

79.3 space() function
Use the space function to allocate a speciﬁc 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
Note: You may need the space() and VarPtr() functions to pass buffers to C functions.
79.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 ﬁrst.
Tip: We can pass NULL as parameter instead of using NULLPointer()
79.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 )
79.3. space() function 885

79.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
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).
79.7 ispointer() function
Check if the parameter is a pointer (C Object) or not.
Syntax:
IsPointer(vPara) ---> True|False
Example :
79.6. pointer2object() function 886

fp = fopen(filename(),"r")
? type(fp)
? ispointer(fp)
Output :
file
1
79.8 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
79.9 ringvm_cfunctionslist() function
The Function return a list of functions written in C.
Syntax:
RingVM_CFunctionsList() ---> List
Example:
See RingVM_CFunctionsList()
79.10 ringvm_functionslist() function
The Function return a list of functions written in Ring.
Each List Member is a list contains the next items
79.8. ptrcmp() function 887

The Ring programming language version 1.10 book - Part 92 of 212

More Related Content

What's hot (20)

Similar to The Ring programming language version 1.10 book - Part 92 of 212 (20)

More from Mahmoud Samir Fayed (20)

Recently uploaded (20)

The Ring programming language version 1.10 book - Part 92 of 212