source/documentation/reference/structures.html · PureBasic/SpiderBasicPreference

Fetch the repository succeeded.

Scan WeChat QR to Pay

Cancel

Complete

richgiteeai

Watch

Unwatch Watching Releases Only Ignoring

1 Star 0 Fork 0

PureBasic/SpiderBasicPreference

Code Issues 0 Pull Requests 0 Wiki Insights Pipelines

Service

Tencent Cloud Serverless

Create your Gitee Account

Explore and code with more than 14 million developers,Free private repositories !:)

Already have an account? Sign in

文件

master

Branches (1)

Manage

master

This repository doesn't specify license. Please pay attention to the specific project description and its upstream code dependency when using it.

The license selected for the repository is subject to the license used by the main branch of the repository.

Clone or Download

Clone/Download

HTTPS SSH SVN SVN+SSH Download ZIP

Prompt

To download the code, please copy the following command and execute it in the terminal

To ensure that your submitted code identity is correctly recognized by Gitee, please execute the following command.

git config --global user.name userName 
git config --global user.email userEmail

When using the SSH protocol for the first time to clone or push code, follow the prompts below to complete the SSH configuration.

1 Generate RSA keys.

2 Obtain the content of the RSA public key and configure it in SSH Public Keys

To use SVN on Gitee, please visit the usage guide

When using the HTTPS protocol, the command line will prompt for account and password verification as follows. For security reasons, Gitee recommends configure and use personal access tokens instead of login passwords for cloning, pushing, and other operations.

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # Private Token

Branches 1

Tags 0

SpiderBasicPreference

source

documentation

reference

structures.html

structures.html 7.04 KB

<html><head><title>Structures</title></head>
<body bgcolor="#FFFFFF" link="#207BC3" vlink="#003B83" alink="#003B83">
Structures

Syntax<blockquote><pre>Structure &lt;name&gt; [Extends &lt;name&gt;]
 ...
EndStructure 
</pre></blockquote>
Description <blockquote>

Structure is useful to define user type, and access some OS memory areas. Structures can be used 
to enable faster and easier handling of data files. It is very useful as you can group into the same 
object the information which are common. Structures fields are accessed with the \ option. Structures 
can be nested. Statics arrays are supported inside structures. 
 
Dynamic objects like arrays, lists and maps are supported inside structure and are automatically initialized 
when the object using the structure is created. To declare such field, use the following keywords: 
Array, List and Map. 
 
The optional Extends parameter allows to extends another structure with new fields. All fields 
found in the extended structure will be available in the new structure and will be placed before 
the new fields. This is useful to do basic inheritance of structures. 
 
<a href="compilerfunctions.html">SizeOf</a> can be used with structures to get the size of the structure and <a href="compilerfunctions.html">OffsetOf</a> can be used to retrieve 
the index of the specified field. 
 
Please note, that in structures a static array[] doesn't behave like the normal BASIC array (defined using <a href="dim.html">Dim</a>) 
to be conform to the C/C++/JavaScript structure format (to allow direct API structure porting). This means that a[2] will 
allocate an array from 0 to 1 where Dim a(2) will allocate an array from 0 to 2. 
 
 
When using <a href="memory.html">pointers</a> in structures, the '*' has to be omitted when using the field, once more to ease API code porting. It can be 
seen as an oddity (and to be honest, it is) but it's like that since the very start of SpiderBasic and many, many sources rely 
on that so it won't be changed. 
 
 
When using a lot of structure fields you can use the <a href="with_endwith.html">With</a> : <a href="with_endwith.html">EndWith</a> 
keywords to reduce the amount of code to type and ease its readability. 
 
 
It's possible to perform a full structure copy by using the equal affectation between two structure element of the same type. 
 
 
<a href="compilerfunctions.html">ClearStructure</a> can be used to clear a structured memory area. It's for advanced use only, when 
<a href="memory.html">pointers</a> are involved.

</blockquote>Example<blockquote>

<pre> Structure Person
 Name.s
 ForName.s 
 Age.w 
 EndStructure

Dim MyFriends.Person(100)

; Here the position '0' of the array MyFriend()
 ; will contain one person and it's own information

MyFriends(0)\Name = &quot;Andersson&quot;
 MyFriends(0)\Forname = &quot;Richard&quot; 
 MyFriends(0)\Age = 32
</pre>

</blockquote>Example: A more complex structure (Nested and static array)<blockquote>

<pre> Structure Window
 *NextWindow.Window ; Points to another window object
 x.w 
 y.w
 Name.s[10] ; 10 Names available (from 0 to 9)
 EndStructure
</pre>

</blockquote>Example: Extended structure<blockquote>

<pre> Structure MyPoint
 x.l 
 y.l
 EndStructure

Structure MyColoredPoint Extends MyPoint
 color.l 
 EndStructure

ColoredPoint.MyColoredPoint\x = 10
 ColoredPoint.MyColoredPoint\y = 20
 ColoredPoint.MyColoredPoint\color = RGB(255, 0, 0)
</pre>

</blockquote>Example: Structure copy<blockquote>

<pre> Structure MyPoint
 x.l 
 y.l
 EndStructure

LeftPoint.MyPoint\x = 10
 LeftPoint\y = 20
 
 RightPoint.MyPoint = LeftPoint
 
 Debug RightPoint\x
 Debug RightPoint\y
</pre>

</blockquote>Example: Dynamic object<blockquote>

<pre> Structure Person
 Name$
 Age.l
 List Friends$()
 EndStructure

John.Person
 John\Name$ = &quot;John&quot;
 John\Age = 23
 
 ; Now, add some friends to John
 ;
 AddElement(John\Friends$())
 John\Friends$() = &quot;Jim&quot;

AddElement(John\Friends$())
 John\Friends$() = &quot;Monica&quot;
 
 ForEach John\Friends$()
 Debug John\Friends$()
 Next
</pre>

</blockquote>Example: Pointers<blockquote>

<pre> Structure Person
 *Next.Person ; Here the '*' is mandatory to declare a pointer
 Name$
 Age.b
 EndStructure

Timo.Person\Name$ = &quot;Timo&quot;
 Timo\Age = 25
 
 Fred.Person\Name$ = &quot;Fred&quot;
 Fred\Age = 25
 
 Timo\Next = @Fred ; When using the pointer, the '*' is omitted
 
 Debug Timo\Next\Name$ ; Will print 'Fred'
</pre>

</body></html>

Copy Edit Raw Blame History

麦壳饼 authored 2016年07月26日 10:47 +08:00 . chuci tijiao

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161

<html><head><title>Structures</title></head>
<body bgcolor="#FFFFFF" link="#207BC3" vlink="#003B83" alink="#003B83">
<font face="Arial" size="2"><p align="center"><b><font size="5">Structures</font></b></p>

<br><b>Syntax</b><blockquote><pre><font face="Courier New, Courier, mono"size="2"><b><font color="#207BC3">Structure</font></b> &lt;name&gt; [<b><font color="#207BC3">Extends</font></b> &lt;name&gt;]
 ...
<b><font color="#207BC3">EndStructure</font></b> 
</font></pre></blockquote>
<b>Description</b><br><blockquote>


<b><font color="#207BC3">Structure</font></b> is useful to define user type, and access some OS memory areas. Structures can be used 
to enable faster and easier handling of data files. It is very useful as you can group into the same 
object the information which are common. Structures fields are accessed with the <b><font color="#207BC3">\</font></b> option. Structures 
can be nested. Statics arrays are supported inside structures. <br>
<br>
Dynamic objects like arrays, lists and maps are supported inside structure and are automatically initialized 
when the object using the structure is created. To declare such field, use the following keywords: 
<b><font color="#207BC3">Array</font></b>, <b><font color="#207BC3">List</font></b> and <b><font color="#207BC3">Map</font></b>. <br>
<br>
The optional <b><font color="#207BC3">Extends</font></b> parameter allows to extends another structure with new fields. All fields 
found in the extended structure will be available in the new structure and will be placed before 
the new fields. This is useful to do basic inheritance of structures. <br>
<br>
<a href="compilerfunctions.html">SizeOf</a> can be used with structures to get the size of the structure and <a href="compilerfunctions.html">OffsetOf</a> can be used to retrieve 
the index of the specified field. <br>
<br>
Please note, that in structures a static array[] doesn't behave like the normal BASIC array (defined using <a href="dim.html">Dim</a>) 
to be conform to the C/C++/JavaScript structure format (to allow direct API structure porting). This means that a[2] will 
allocate an array from 0 to 1 where Dim a(2) will allocate an array from 0 to 2. 
<br>
<br>
When using <a href="memory.html">pointers</a> in structures, the '*' has to be omitted when using the field, once more to ease API code porting. It can be 
seen as an oddity (and to be honest, it is) but it's like that since the very start of SpiderBasic and many, many sources rely 
on that so it won't be changed. 
<br>
<br>
When using a lot of structure fields you can use the <a href="with_endwith.html">With</a> : <a href="with_endwith.html">EndWith</a> 
keywords to reduce the amount of code to type and ease its readability. 
<br>
<br>
It's possible to perform a full structure copy by using the equal affectation between two structure element of the same type. 
<br>
<br>
<a href="compilerfunctions.html">ClearStructure</a> can be used to clear a structured memory area. It's for advanced use only, when 
<a href="memory.html">pointers</a> are involved. <br>


</blockquote><p><b>Example</b></p><blockquote>


<pre><font face="Courier New, Courier, mono"size="2"> <b><font color="#207BC3">Structure</font></b> Person
 Name.s
 ForName.s 
 Age.w 
 <b><font color="#207BC3">EndStructure</font></b>

 <b><font color="#207BC3">Dim</font></b> <font color="#207BC3">MyFriends</font>.Person(100)

 <font color="#207BC3">; Here the position '0' of the array MyFriend()</font>
 <font color="#207BC3">; will contain one person and it's own information</font>

<font color="#207BC3"> MyFriends</font>(0)\Name = &quot;Andersson&quot;
<font color="#207BC3"> MyFriends</font>(0)\Forname = &quot;Richard&quot; 
<font color="#207BC3"> MyFriends</font>(0)\Age = 32
</font></pre>

</blockquote><p><b>Example:</b> A more complex structure (Nested and static array)</p><blockquote>


<pre><font face="Courier New, Courier, mono"size="2"> <b><font color="#207BC3">Structure</font></b> Window
 *NextWindow.Window <font color="#207BC3">; Points to another window object</font>
 x.w 
 y.w
 Name.s[10] <font color="#207BC3">; 10 Names available (from 0 to 9)</font>
 <b><font color="#207BC3">EndStructure</font></b>
</font></pre>

</blockquote><p><b>Example:</b> Extended structure</p><blockquote>


<pre><font face="Courier New, Courier, mono"size="2"> <b><font color="#207BC3">Structure</font></b> MyPoint
 x.l 
 y.l
 <b><font color="#207BC3">EndStructure</font></b>

 <b><font color="#207BC3">Structure</font></b> MyColoredPoint <b><font color="#207BC3">Extends</font></b> MyPoint
 color.l 
 <b><font color="#207BC3">EndStructure</font></b>

 ColoredPoint.MyColoredPoint\x = 10
 ColoredPoint.MyColoredPoint\y = 20
 ColoredPoint.MyColoredPoint\color =<font color="#207BC3"> RGB</font>(255, 0, 0)
</font></pre>


</blockquote><p><b>Example:</b> Structure copy</p><blockquote>


<pre><font face="Courier New, Courier, mono"size="2"> <b><font color="#207BC3">Structure</font></b> MyPoint
 x.l 
 y.l
 <b><font color="#207BC3">EndStructure</font></b>

 LeftPoint.MyPoint\x = 10
 LeftPoint\y = 20
 
 RightPoint.MyPoint = LeftPoint
 
 <b><font color="#207BC3">Debug</font></b> RightPoint\x
 <b><font color="#207BC3">Debug</font></b> RightPoint\y
</font></pre>

</blockquote><p><b>Example:</b> Dynamic object</p><blockquote>


<pre><font face="Courier New, Courier, mono"size="2"> <b><font color="#207BC3">Structure</font></b> Person
 Name$
 Age.l
 <b><font color="#207BC3">List</font></b> <font color="#207BC3">Friends$</font>()
 <b><font color="#207BC3">EndStructure</font></b>

 John.Person
 John\Name$ = &quot;John&quot;
 John\Age = 23
 
 <font color="#207BC3">; Now, add some friends to John</font>
 <font color="#207BC3">;</font>
<font color="#207BC3"> AddElement</font>(John\<font color="#207BC3">Friends$</font>())
 John\<font color="#207BC3">Friends$</font>() = &quot;Jim&quot;

<font color="#207BC3"> AddElement</font>(John\<font color="#207BC3">Friends$</font>())
 John\<font color="#207BC3">Friends$</font>() = &quot;Monica&quot;
 
 <b><font color="#207BC3">ForEach</font></b> John\<font color="#207BC3">Friends$</font>()
 <b><font color="#207BC3">Debug</font></b> John\<font color="#207BC3">Friends$</font>()
 <b><font color="#207BC3">Next</font></b>
</font></pre>


</blockquote><p><b>Example:</b> Pointers</p><blockquote>


<pre><font face="Courier New, Courier, mono"size="2"> <b><font color="#207BC3">Structure</font></b> Person
 *Next.Person <font color="#207BC3">; Here the '*' is mandatory to declare a pointer</font>
 Name$
 Age.b
 <b><font color="#207BC3">EndStructure</font></b>

 Timo.Person\Name$ = &quot;Timo&quot;
 Timo\Age = 25
 
 Fred.Person\Name$ = &quot;Fred&quot;
 Fred\Age = 25
 
 Timo\Next = @Fred <font color="#207BC3">; When using the pointer, the '*' is omitted</font>
 
 <b><font color="#207BC3">Debug</font></b> Timo\Next\Name$ <font color="#207BC3">; Will print 'Fred'</font>
</font></pre>

</body></html>