├── COPYING.LESSER
├── COPYING.txt
├── LEIAME.md
├── Makefile
├── README.md
├── include
├── aarray.ch
├── json.ch
└── shash.ch
└── lib
├── JSON.prg
└── SHash.prg
/COPYING.LESSER:
--------------------------------------------------------------------------------
1 | GNU LESSER GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 |
9 | This version of the GNU Lesser General Public License incorporates
10 | the terms and conditions of version 3 of the GNU General Public
11 | License, supplemented by the additional permissions listed below.
12 |
13 | 0. Additional Definitions.
14 |
15 | As used herein, "this License" refers to version 3 of the GNU Lesser
16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU
17 | General Public License.
18 |
19 | "The Library" refers to a covered work governed by this License,
20 | other than an Application or a Combined Work as defined below.
21 |
22 | An "Application" is any work that makes use of an interface provided
23 | by the Library, but which is not otherwise based on the Library.
24 | Defining a subclass of a class defined by the Library is deemed a mode
25 | of using an interface provided by the Library.
26 |
27 | A "Combined Work" is a work produced by combining or linking an
28 | Application with the Library. The particular version of the Library
29 | with which the Combined Work was made is also called the "Linked
30 | Version".
31 |
32 | The "Minimal Corresponding Source" for a Combined Work means the
33 | Corresponding Source for the Combined Work, excluding any source code
34 | for portions of the Combined Work that, considered in isolation, are
35 | based on the Application, and not on the Linked Version.
36 |
37 | The "Corresponding Application Code" for a Combined Work means the
38 | object code and/or source code for the Application, including any data
39 | and utility programs needed for reproducing the Combined Work from the
40 | Application, but excluding the System Libraries of the Combined Work.
41 |
42 | 1. Exception to Section 3 of the GNU GPL.
43 |
44 | You may convey a covered work under sections 3 and 4 of this License
45 | without being bound by section 3 of the GNU GPL.
46 |
47 | 2. Conveying Modified Versions.
48 |
49 | If you modify a copy of the Library, and, in your modifications, a
50 | facility refers to a function or data to be supplied by an Application
51 | that uses the facility (other than as an argument passed when the
52 | facility is invoked), then you may convey a copy of the modified
53 | version:
54 |
55 | a) under this License, provided that you make a good faith effort to
56 | ensure that, in the event an Application does not supply the
57 | function or data, the facility still operates, and performs
58 | whatever part of its purpose remains meaningful, or
59 |
60 | b) under the GNU GPL, with none of the additional permissions of
61 | this License applicable to that copy.
62 |
63 | 3. Object Code Incorporating Material from Library Header Files.
64 |
65 | The object code form of an Application may incorporate material from
66 | a header file that is part of the Library. You may convey such object
67 | code under terms of your choice, provided that, if the incorporated
68 | material is not limited to numerical parameters, data structure
69 | layouts and accessors, or small macros, inline functions and templates
70 | (ten or fewer lines in length), you do both of the following:
71 |
72 | a) Give prominent notice with each copy of the object code that the
73 | Library is used in it and that the Library and its use are
74 | covered by this License.
75 |
76 | b) Accompany the object code with a copy of the GNU GPL and this license
77 | document.
78 |
79 | 4. Combined Works.
80 |
81 | You may convey a Combined Work under terms of your choice that,
82 | taken together, effectively do not restrict modification of the
83 | portions of the Library contained in the Combined Work and reverse
84 | engineering for debugging such modifications, if you also do each of
85 | the following:
86 |
87 | a) Give prominent notice with each copy of the Combined Work that
88 | the Library is used in it and that the Library and its use are
89 | covered by this License.
90 |
91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license
92 | document.
93 |
94 | c) For a Combined Work that displays copyright notices during
95 | execution, include the copyright notice for the Library among
96 | these notices, as well as a reference directing the user to the
97 | copies of the GNU GPL and this license document.
98 |
99 | d) Do one of the following:
100 |
101 | 0) Convey the Minimal Corresponding Source under the terms of this
102 | License, and the Corresponding Application Code in a form
103 | suitable for, and under terms that permit, the user to
104 | recombine or relink the Application with a modified version of
105 | the Linked Version to produce a modified Combined Work, in the
106 | manner specified by section 6 of the GNU GPL for conveying
107 | Corresponding Source.
108 |
109 | 1) Use a suitable shared library mechanism for linking with the
110 | Library. A suitable mechanism is one that (a) uses at run time
111 | a copy of the Library already present on the user's computer
112 | system, and (b) will operate properly with a modified version
113 | of the Library that is interface-compatible with the Linked
114 | Version.
115 |
116 | e) Provide Installation Information, but only if you would otherwise
117 | be required to provide such information under section 6 of the
118 | GNU GPL, and only to the extent that such information is
119 | necessary to install and execute a modified version of the
120 | Combined Work produced by recombining or relinking the
121 | Application with a modified version of the Linked Version. (If
122 | you use option 4d0, the Installation Information must accompany
123 | the Minimal Corresponding Source and Corresponding Application
124 | Code. If you use option 4d1, you must provide the Installation
125 | Information in the manner specified by section 6 of the GNU GPL
126 | for conveying Corresponding Source.)
127 |
128 | 5. Combined Libraries.
129 |
130 | You may place library facilities that are a work based on the
131 | Library side by side in a single library together with other library
132 | facilities that are not Applications and are not covered by this
133 | License, and convey such a combined library under terms of your
134 | choice, if you do both of the following:
135 |
136 | a) Accompany the combined library with a copy of the same work based
137 | on the Library, uncombined with any other library facilities,
138 | conveyed under the terms of this License.
139 |
140 | b) Give prominent notice with the combined library that part of it
141 | is a work based on the Library, and explaining where to find the
142 | accompanying uncombined form of the same work.
143 |
144 | 6. Revised Versions of the GNU Lesser General Public License.
145 |
146 | The Free Software Foundation may publish revised and/or new versions
147 | of the GNU Lesser General Public License from time to time. Such new
148 | versions will be similar in spirit to the present version, but may
149 | differ in detail to address new problems or concerns.
150 |
151 | Each version is given a distinguishing version number. If the
152 | Library as you received it specifies that a certain numbered version
153 | of the GNU Lesser General Public License "or any later version"
154 | applies to it, you have the option of following the terms and
155 | conditions either of that published version or of any later version
156 | published by the Free Software Foundation. If the Library as you
157 | received it does not specify a version number of the GNU Lesser
158 | General Public License, you may choose any version of the GNU Lesser
159 | General Public License ever published by the Free Software Foundation.
160 |
161 | If the Library as you received it specifies that a proxy can decide
162 | whether future versions of the GNU Lesser General Public License shall
163 | apply, that proxy's public statement of acceptance of any version is
164 | permanent authorization for you to choose that version for the
165 | Library.
166 |
--------------------------------------------------------------------------------
/COPYING.txt:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/LEIAME.md:
--------------------------------------------------------------------------------
1 | JSON e Vetores Associativos para AdvPL
2 | ======================================
3 |
4 | JSON e Vetores Associativos são bem úteis para a troca de dados entre programas.
5 |
6 | Essa biblioteca é Software Livre dentro dos termos da LGPLv3 ou posterior.
7 |
8 | Foi testado com AdvPL e Harbour.
9 |
10 | This documentation can also be found in [English](README.md).
11 |
12 | ## Índice
13 |
14 | * Vetores Associativos
15 | * Como adicionar suporte à vetores Vetores Associativos
16 | * Como usar Vetores Associativos
17 | * Como funciona internamente
18 | * JSON
19 | * Como adicionar suporte ao JSON
20 | * FromJson(cJstr)
21 | * ToJson(uAnyVar)
22 | * EscpJsonStr(cJsStr)
23 | * JsonPrettify(cJstr [,nTab])
24 | * JsonMinify(cJstr)
25 | * ReadJsonFile(cFileName [,lStripComments])
26 | * Licença
27 | * Por que GPL?
28 |
29 | ## Vetores Associativos
30 |
31 | ### Como adicionar suporte à vetores Vetores Associativos
32 |
33 | 1. Adicione o arquivo SHash.prg em seu projeto;
34 |
35 | 2. Compile SHash.prg.
36 |
37 | 3. Inclua o arquivo cabeçalho em todo projeto que precisar usá-lo:
38 |
39 | ```AdvPL
40 |
41 | #Include "aarray.ch"
42 | ```
43 |
44 | 4. Use-o. ;)
45 |
46 |
47 | ### Como usar Vetores Associativos
48 |
49 | É muito fácil aprender através de exemplos, não é?
50 |
51 | Exemplo:
52 |
53 | ```AdvPL
54 |
55 | // Inicia um Vetor Associativo
56 | aaFriends := Array(#)
57 |
58 | // Inicia outro Vetor Associativo em cima do anterior
59 | aaFriends[#"Arthur"] := Array(#)
60 |
61 | // Define valores:
62 | aaFriends[#"Arthur"][#"Name"] := "Arthur"
63 | aaFriends[#"Arthur"][#"Account"] := 230251
64 | aaFriends[#"Arthur"][#"Work"] := "Software Developer"
65 |
66 | // Inicia um novo Vetor Associativo e define valores
67 | aaFriends[#"David"] := Array(#)
68 | aaFriends[#"David"][#"Name"] := "David"
69 | aaFriends[#"David"][#"Account"] := 187204
70 | aaFriends[#"David"][#"Work"] := "Web Designer"
71 |
72 | // Vamos fazer algo interessante!
73 |
74 | aaFriends[#"David"][#"Best Friend"] := aaFriends[#"Arthur"]
75 |
76 | // E testar:
77 |
78 | Alert (aaFriends[#"David"][#"Best Friend"][#"Name"])
79 | Alert (aaFriends[#"David"][#"Best Friend"][#"Work"])
80 |
81 | // Também podemos misturá-los com Vetores normais:
82 | aaFriends[#"Arthur"][#"Friends"] := Array(1)
83 | aaFriends[#"Arthur"][#"Friends"][1] := aaFriends[#"David"]
84 |
85 | Alert (aaFriends[#"Arthur"][#"Friends"][1][#"Name"])
86 |
87 | ```
88 |
89 |
90 | ### Como funciona internamente
91 |
92 | Quando criamos um Vetor Associativo, estamos na verdade instanciando uma classe e criando um objeto.
93 |
94 | Dê uma olhada:
95 |
96 | ```AdvPL
97 |
98 | aaFriends := Array(#)
99 | aaFriends[#"David"] := Array(#)
100 | aaFriends[#"David"][#"Account"] := 187204
101 | ```
102 |
103 | Isto é traduzido por isso pelo pré-compilador:
104 |
105 | ```AdvPL
106 |
107 | aaFriends := SHash():New()
108 | aaFriends:Set("David", SHash():New())
109 | aaFriends:Get("David"):Set("Account", 187204)
110 | ```
111 |
112 | Os objetos SHash contêm o vetor SHash que armazena todos os dados, então é muito fácil acessar tudo através de um loop:
113 |
114 | ```AdvPL
115 | For i := 1 to len(aaFriends:aData)
116 | QOut( aaFriends:aData[i][1] +': '+ aaFriends:aData[i][2] )
117 | Next
118 | ```
119 |
120 | ## JSON
121 |
122 | ### Como adicionar suporte ao JSON
123 |
124 | 1. Adicione os arquivos JSON.prg e SHash.prg em seu projeto.
125 |
126 | 2. Compile JSON.prg e SHash.prg.
127 |
128 | 3. Inclua os arquivos de cabeçalhos em todo projeto que precisar usá-lo:
129 |
130 | ```AdvPL
131 |
132 | #Include "aarray.ch"
133 | #Include "json.ch"
134 | ```
135 |
136 | 4. Veja a documentação das funções, é bem facil. ;)
137 |
138 |
139 | * Nota: Graças ao pré-processador podemos chamar as funções de usuários sem o U_, veja o arquivo aarray.ch para entender melhor.
140 |
141 |
142 | - - - - - - - - - - - - - -
143 |
144 | ### (User) Function: FromJson(cJstr)
145 |
146 | Converte strings JSON em qualquer valor que contenha.
147 |
148 | #### Exemplo:
149 |
150 | ```AdvPL
151 |
152 | cJSON := '{"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 4e-1}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}'
153 |
154 | aaBusiness := FromJson(cJSON)
155 |
156 | alert(aaBusiness[#'Products'][1][#'Name']) // Retorna -> Water
157 |
158 | alert(aaBusiness[#'Products'][2][#'Cost']) // Retorna -> 0.4
159 |
160 | alert(aaBusiness[#'Users'][1][#'Comment']) // Retorna -> Hello" \World
161 | ```
162 |
163 |
164 | #### Informações Adicionais:
165 |
166 | * É aceito Notação Científica E nos números
167 | 234e-7 = 0.0000234
168 | 57e3 = 57000
169 |
170 | * Não sei como usar Unicode em AdvPL, por isso a expressão \uXXXX converte para ASCII. Valores fora da tabela ASCII se tornam '?' (pontos de interrogação).
171 |
172 | @param cJstr - A string JSON que você deseja converter
173 | @return - Resultado da conversão no formato apropriado. Retorna Nil em caso de um JSON mal formatado.
174 |
175 |
176 | - - - - - - - - - - - - - -
177 |
178 | ### (User) Function: ToJson(uAnyVar)
179 |
180 | Converte valor AdvPL em string JSON
181 | Valores aceitos: Strings, Números, Lógicos, Nil, Vetores e Vetores Associativos (Objetos SHash)
182 |
183 | #### Exemplo:
184 |
185 | ```AdvPL
186 |
187 | aaBusiness := Array(#)
188 | aaBusiness[#'Products'] := Array(2)
189 | aaBusiness[#'Products'][1] := Array(#)
190 | aaBusiness[#'Products'][1][#'Name'] := "Water"
191 | aaBusiness[#'Products'][1][#'Cost'] := 1.3
192 | aaBusiness[#'Products'][2] := Array(#)
193 | aaBusiness[#'Products'][2][#'Name'] := "Bread"
194 | aaBusiness[#'Products'][2][#'Cost'] := 0.4
195 | aaBusiness[#'Users'] := Array(1)
196 | aaBusiness[#'Users'][1] := Array(#)
197 | aaBusiness[#'Users'][1][#'Name'] := "Arthur"
198 | aaBusiness[#'Users'][1][#'Comment'] := 'Hello" \World'
199 |
200 |
201 | alert( ToJson(aaBusiness) )
202 | ```
203 |
204 | Retorna:
205 |
206 | ```json
207 |
208 | {"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 0.4}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}
209 | ```
210 |
211 | #### Informações Adicionais:
212 |
213 | @param uAnyVar - O valor que a ser convertido
214 | @return string - String JSON
215 |
216 |
217 | - - - - - - - - - - - - - -
218 |
219 | ### (User) Function: EscpJsonStr(cJsStr)
220 |
221 | Escapa string para o formato de string JSON
222 | ToJson() automaticamente escapa strings, essa função não tem muita necessidade a menos que você queira escrever strings JSON por conta própria.
223 |
224 | #### Exemplo:
225 |
226 | ```AdvPL
227 |
228 | cProdName := 'Cool" and \ cool"'
229 |
230 | cJSON := '{"Product": {"Name": "'+ EscpJsonStr(cProdName) +'"}}'
231 |
232 | alert( JsonPrettify(cJSON) ) // -> {"Product": {"Name": "Cool\" and \\ cool\""}}
233 | ```
234 |
235 | #### Informações Adicionais:
236 |
237 | @param cJsStr - String que deseja escapar
238 | @return cJsStr - String JSON escapada
239 |
240 |
241 | - - - - - - - - - - - - - -
242 |
243 | ### (User) Function: JsonPrettify(cJstr [,nTab])
244 |
245 | Embeleza uma string JSON, ou seja, indenta e deixa a leitura mais fácil.
246 |
247 | #### Exemplo:
248 |
249 | ```AdvPL
250 | cJSON := '{"Products": [{"Name": "Water", "Cost": 1.30}, {"Name": "Bread", "Cost": 0.40}]}'
251 |
252 | alert( JsonPrettify(cJSON, 4) )
253 | ```
254 |
255 | Resulta em:
256 |
257 | ```json
258 |
259 | {
260 | "Products": [
261 | {
262 | "Name": "Water",
263 | "Cost": 1.30
264 | },
265 | {
266 | "Name": "Bread",
267 | "Cost": 0.40
268 | }
269 | ]
270 | }
271 | ```
272 |
273 | #### Informações Adicionais:
274 |
275 | @param cJstr - String JSON a ser embelezada
276 | @param nTab (opcional) - Número de espaços para indentação ou -1 para tabulação (\t) (Padrão: -1)
277 | @return string - String JSON embelezada
278 |
279 |
280 | - - - - - - - - - - - - - -
281 |
282 | ### (User) Function: JsonMinify(cJstr)
283 |
284 | Remove espaços, quebra de linhas e comentários
285 |
286 | Comentários não são permitidos dentro da especificação JSON, mas usá-los e removê-los com essa função.
287 |
288 | Comentários permitidos:
289 |
290 | ```javascript
291 |
292 | // Comentários de uma linha
293 |
294 | /* Comentários
295 | de Múltiplas
296 | Linhas */
297 | ```
298 |
299 | #### Exemplo:
300 |
301 | ```AdvPL
302 |
303 | cJSON := '{' + CRLF
304 | cJSON += ' // Isto é um comentário ' + CRLF
305 | cJSON += ' "Products": [35, 50]' + CRLF
306 | cJSON += '}'
307 |
308 | cJSON := JsonMinify(cJSON) // -> Retorna '{"Products":[35,50]}'
309 | ```
310 |
311 | #### Informações Adicionais:
312 |
313 | Essa função foi portada do JSONLint de Chris Dary:
314 |
315 |
316 |
317 | Uma cópia de sua licença está junta ao código.
318 |
319 | @param cJstr - String JSON a se minificada
320 | @return string - String JSON minificada
321 |
322 |
323 | - - - - - - - - - - - - - -
324 |
325 | ### (User) Function: ReadJsonFile(cFileName [,lStripComments])
326 |
327 | Lê um arquivo JSON.
328 |
329 | #### Exemplo:
330 |
331 | ```AdvPL
332 |
333 | aaConf := ReadJsonFile("D:\TOTVS\Config.json")
334 | alert(aaConf[#'Product'][35][#'name'])
335 | ```
336 |
337 | #### Informações Adicionais:
338 |
339 | @param cFileName - Nome do arquivo
340 | @param lStripComments (Opcional) - .T. remove comentários, .F. não remove. (Padrão .T.)
341 | @return AnyValue - Retorna o valor do arquivo JSON
342 |
343 |
344 | ## Licença
345 | Copyright (C) 2013 Arthur Helfstein Fragoso
346 |
347 | This program is free software: you can redistribute it and/or modify
348 | it under the terms of the GNU Lesser General Public License as published
349 | by the Free Software Foundation, either version 3 of the License, or
350 | (at your option) any later version.
351 |
352 | This program is distributed in the hope that it will be useful,
353 | but WITHOUT ANY WARRANTY; without even the implied warranty of
354 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
355 | GNU General Public License for more details.
356 |
357 | You should have received a copy of the GNU Lesser General Public License
358 | along with this program. If not, see .
359 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for compiling the JSON lib on Harbour
2 | #
3 | # This is mostly for testing, it's better to use Harbour's internal functions:
4 | # hb_jsonEncode
5 | # hb_jsonDecode
6 | #
7 | # To the extent possible under law, Arthur Helfstein Fragoso has waived all copyright and related or neighboring rights to this Makefile.
8 |
9 | HC=hbmk2
10 |
11 | HFLAGS=-lhbct -i./include
12 |
13 | all: libJSON.a
14 |
15 | libJSON.a:
16 | $(HC) $(HFLAGS) lib/JSON.prg -hblib
17 |
18 | clean:
19 | rm -rf libJSON.a
20 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | JSON and Associative Arrays for AdvPL
2 | =====================================
3 |
4 | JSON and Associative Arrays are very useful for interchanging data between different programs.
5 |
6 | This library is Free Software under LGPLv3 or later.
7 |
8 | It was tested on AdvPL and Harbour.
9 |
10 | This documentation can also be found in [Portuguese](LEIAME.md).
11 |
12 | ## Index
13 |
14 | * Associative Arrays
15 | * How to add Associative Arrays support
16 | * How to use Associative Arrays
17 | * How does it work on the background?
18 | * JSON
19 | * How to add JSON support
20 | * FromJson(cJstr)
21 | * ToJson(uAnyVar)
22 | * EscpJsonStr(cJsStr)
23 | * JsonPrettify(cJstr [,nTab])
24 | * JsonMinify(cJstr)
25 | * ReadJsonFile(cFileName [,lStripComments])
26 | * License
27 | * Why GPL?
28 |
29 | ## Associative Arrays
30 |
31 | ### How to add Associative Arrays support
32 |
33 | 1. Add the file SHash.prg to your project.
34 |
35 | 2. Compile SHash.prg.
36 |
37 | 3. Include the header file to any project you want to use it:
38 |
39 | ```AdvPL
40 | #Include "aarray.ch"
41 | ```
42 |
43 | 4. Use it. ;)
44 |
45 |
46 | ### How to use Associative Arrays
47 |
48 | It's easier to learn from examples, isn't it?
49 |
50 | Example:
51 |
52 | ```AdvPL
53 |
54 | // Start an Associative Array
55 | aaFriends := Array(#)
56 |
57 | // Start another another Associative Array on top of the other
58 | aaFriends[#"Arthur"] := Array(#)
59 |
60 | // Set values:
61 | aaFriends[#"Arthur"][#"Name"] := "Arthur"
62 | aaFriends[#"Arthur"][#"Account"] := 230251
63 | aaFriends[#"Arthur"][#"Work"] := "Software Developer"
64 |
65 | // Start a new Associative Array and set values
66 | aaFriends[#"David"] := Array(#)
67 | aaFriends[#"David"][#"Name"] := "David"
68 | aaFriends[#"David"][#"Account"] := 187204
69 | aaFriends[#"David"][#"Work"] := "Web Designer"
70 |
71 | // Let's do something interesting:
72 |
73 | aaFriends[#"David"][#"Best Friend"] := aaFriends[#"Arthur"]
74 |
75 | // And test it:
76 |
77 | Alert (aaFriends[#"David"][#"Best Friend"][#"Name"])
78 | Alert (aaFriends[#"David"][#"Best Friend"][#"Work"])
79 |
80 | // We can also mix it with the regular Array:
81 | aaFriends[#"Arthur"][#"Friends"] := Array(1)
82 | aaFriends[#"Arthur"][#"Friends"][1] := aaFriends[#"David"]
83 |
84 | Alert (aaFriends[#"Arthur"][#"Friends"][1][#"Name"])
85 | ```
86 |
87 | ### How does it work on the background?
88 |
89 | When we create an Associative Array, we are in reality instantiating a Class and creating an Object.
90 |
91 | Take a look at it working, this:
92 |
93 | ```AdvPL
94 |
95 | aaFriends := Array(#)
96 | aaFriends[#"David"] := Array(#)
97 | aaFriends[#"David"][#"Account"] := 187204
98 | ```
99 |
100 | is translated to this by the precompiler:
101 |
102 | ```AdvPL
103 |
104 | aaFriends := SHash():New()
105 | aaFriends:Set("David", SHash():New())
106 | aaFriends:Get("David"):Set("Account", 187204)
107 | ```
108 |
109 | The SHash object has the aData array that stores all the data, so you can easily access all the data thought a loop:
110 |
111 | ```AdvPL
112 |
113 | For i := 1 to len(aaFriends:aData)
114 | QOut( aaFriends:aData[i][1] +': '+ aaFriends:aData[i][2] )
115 | Next
116 | ```
117 |
118 | ## JSON
119 |
120 | ### How to add JSON support
121 |
122 | 1. Add the files JSON.prg and SHash.prg to your project.
123 |
124 | 2. Compile JSON.prg and SHash.prg.
125 |
126 | 3. Include the header files to any project you want to use it:
127 |
128 | ```AdvPL
129 |
130 | #Include "aarray.ch"
131 | #Include "json.ch"
132 | ```
133 |
134 | 4. See the functions documentation, it's very easy to use it. ;)
135 |
136 |
137 | * Note: Thanks to the preprocessor we can call user functions without the U_, look at the aarray.ch header file to understand it better.
138 |
139 |
140 | - - - - - - - - - - - - - -
141 |
142 | ### (User) Function: FromJson(cJstr)
143 |
144 | Converts from a JSON string into any value it holds
145 |
146 | #### Example:
147 |
148 | ```AdvPL
149 |
150 | cJSON := '{"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 4e-1}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}'
151 |
152 | aaBusiness := FromJson(cJSON)
153 |
154 | alert(aaBusiness[#'Products'][1][#'Name']) // Returns -> Water
155 |
156 | alert(aaBusiness[#'Products'][2][#'Cost']) // Returns -> 0.4
157 |
158 | alert(aaBusiness[#'Users'][1][#'Comment']) // Returns -> Hello" \World
159 | ```
160 |
161 | #### Additional Info:
162 |
163 | * Numbers accept the Scientific E Notation
164 | 234e-7 = 0.0000234
165 | 57e3 = 57000
166 | * I don't know how I can make an Unicode or UTF-8 character in AdvPL, so the json \uXXXX converts an ASCII code. Values outside the ASCII table becomes '?' (quotation marks).
167 |
168 | @param cJstr - The JSON string you want to convert from
169 | @return - The converted JSON string, it can be any type. Or Nil in case of a bad formatted JSON string.
170 |
171 |
172 | - - - - - - - - - - - - - -
173 |
174 | ### (User) Function: ToJson(uAnyVar)
175 |
176 | Converts AdvPLs value into a JSON string
177 | Accepted values: Strings, Numbers, Logicals, Nil, Arrays and Associative Arrays (SHash Objects)
178 |
179 | #### Example:
180 |
181 | ```AdvPL
182 |
183 | aaBusiness := Array(#)
184 | aaBusiness[#'Products'] := Array(2)
185 | aaBusiness[#'Products'][1] := Array(#)
186 | aaBusiness[#'Products'][1][#'Name'] := "Water"
187 | aaBusiness[#'Products'][1][#'Cost'] := 1.3
188 | aaBusiness[#'Products'][2] := Array(#)
189 | aaBusiness[#'Products'][2][#'Name'] := "Bread"
190 | aaBusiness[#'Products'][2][#'Cost'] := 0.4
191 | aaBusiness[#'Users'] := Array(1)
192 | aaBusiness[#'Users'][1] := Array(#)
193 | aaBusiness[#'Users'][1][#'Name'] := "Arthur"
194 | aaBusiness[#'Users'][1][#'Comment'] := 'Hello" \World'
195 |
196 |
197 | alert( ToJson(aaBusiness) )
198 | ```
199 |
200 | Returns:
201 |
202 | ```json
203 | {"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 0.4}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}
204 | ```
205 |
206 | #### Additional Info:
207 |
208 | @param uAnyVar - The value you want to convert to a JSON string
209 | @return string - JSON string
210 |
211 |
212 | - - - - - - - - - - - - - -
213 |
214 | ### (User) Function: EscpJsonStr(cJsStr)
215 |
216 | Escapes string to a JSON string format
217 | ToJson() Automatically escapes strings, there is no much use of this function unless you want to write the JSON strings yourself.
218 |
219 | #### Example:
220 |
221 | ```AdvPL
222 |
223 | cProdName := 'Cool" and \ cool"'
224 |
225 | cJSON := '{"Product": {"Name": "'+ EscpJsonStr(cProdName) +'"}}'
226 |
227 | alert( JsonPrettify(cJSON) ) // -> {"Product": {"Name": "Cool\" and \\ cool\""}}
228 | ```
229 |
230 | #### Additional Info:
231 |
232 | @param cJsStr - The String you want to escape
233 | @return cJsStr - Escaped JSON string
234 |
235 |
236 | - - - - - - - - - - - - - -
237 |
238 | ### (User) Function: JsonPrettify(cJstr [,nTab])
239 |
240 | Prettify a JSON string. It will indent and make it more readable
241 |
242 | #### Example:
243 |
244 | ```AdvPL
245 |
246 | cJSON := '{"Products": [{"Name": "Water", "Cost": 1.30}, {"Name": "Bread", "Cost": 0.40}]}'
247 |
248 | alert( JsonPrettify(cJSON, 4) )
249 | ```
250 |
251 | Result:
252 |
253 | ```json
254 |
255 | {
256 | "Products": [
257 | {
258 | "Name": "Water",
259 | "Cost": 1.30
260 | },
261 | {
262 | "Name": "Bread",
263 | "Cost": 0.40
264 | }
265 | ]
266 | }
267 | ```
268 |
269 | #### Additional Info:
270 |
271 | @param cJstr - The JSON string to prettify
272 | @param nTab (optional) - number of spaces for each indentation, -1 for tabs (\t) (Default: -1)
273 | @return string - Prettified JSON string
274 |
275 |
276 | - - - - - - - - - - - - - -
277 |
278 | ### (User) Function: JsonMinify(cJstr)
279 |
280 | Remove spaces, breaklines, and comments
281 |
282 | Comments are not allowed in the JSON specification, but we can remove them with this function.
283 |
284 | Allowed comments:
285 |
286 | ```javascript
287 |
288 | // Single line comment
289 |
290 | /* Multiple Lines
291 | Multiple Lines
292 | Multiple Lines */
293 | ```
294 |
295 | #### Example:
296 |
297 | ```AdvPL
298 |
299 | cJSON := '{' + CRLF
300 | cJSON += ' // this is a comment' + CRLF
301 | cJSON += ' "Products": [35, 50]' + CRLF
302 | cJSON += '}'
303 |
304 | cJSON := JsonMinify(cJSON) // -> returns '{"Products":[35,50]}'
305 | ```
306 |
307 | #### Additional Info:
308 |
309 | This function was ported from Chris Dary's JSONLint:
310 |
311 |
312 |
313 | A copy of his license is within the code.
314 |
315 | @param cJstr - The JSON string to Minify
316 | @return string - Minified JSON string
317 |
318 |
319 | - - - - - - - - - - - - - -
320 |
321 | ### (User) Function: ReadJsonFile(cFileName [,lStripComments])
322 |
323 | Reads JSON from a JSON file.
324 |
325 | #### Example:
326 |
327 | ```AdvPL
328 |
329 | aaConf := ReadJsonFile("D:\TOTVS\Config.json")
330 | alert(aaConf[#'Product'][35][#'name'])
331 | ```
332 |
333 | #### Additional Info:
334 |
335 | @param cFileName - Filename
336 | @param lStripComments (Optional) - .T. removes comments, .F. doesn't. (Default .T.)
337 | @return AnyValue - Returns the value of the JSON file
338 |
339 |
340 | ## License
341 | Copyright (C) 2013 Arthur Helfstein Fragoso
342 |
343 | This program is free software: you can redistribute it and/or modify
344 | it under the terms of the GNU Lesser General Public License as published
345 | by the Free Software Foundation, either version 3 of the License, or
346 | (at your option) any later version.
347 |
348 | This program is distributed in the hope that it will be useful,
349 | but WITHOUT ANY WARRANTY; without even the implied warranty of
350 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
351 | GNU General Public License for more details.
352 |
353 | You should have received a copy of the GNU Lesser General Public License
354 | along with this program. If not, see .
355 |
--------------------------------------------------------------------------------
/include/aarray.ch:
--------------------------------------------------------------------------------
1 | /*----------------------------------------------------------------------*\
2 | * Associative Arrays for AdvPL
3 | * Copyright (C) 2013 Arthur Helfstein Fragoso
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU Lesser General Public License as published
7 | * by the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU Lesser General Public License
16 | * along with this program. If not, see .
17 | *
18 | * The SHASH class is an adapted version of Marinaldo de Jesus' THASH Class.
19 | *
20 | *----------------------------------------------------------------------*
21 | *
22 | * -- How to install this program:
23 | *
24 | * 1 - Add the file SHash.prg to your project.
25 | *
26 | * 2 - Compile SHash.prg.
27 | *
28 | * 3 - Include the header file to any project you want to use it:
29 | *
30 | * #Include "aarray.ch"
31 | *
32 | * 4 - Use it. ;)
33 | *
34 | *
35 | * -- How to use Associative Arrays:
36 | *
37 | * It's easier to learn from examples, isn't it?
38 | *
39 | * Example:
40 | *
41 | * // Start an Associative Array
42 | * aaFriends := Array(#)
43 | *
44 | * // Start another another Associative Array on top of the other
45 | * aaFriends[#"Arthur"] := Array(#)
46 | *
47 | * // Set values:
48 | * aaFriends[#"Arthur"][#"Name"] := "Arthur"
49 | * aaFriends[#"Arthur"][#"Account"] := 230251
50 | * aaFriends[#"Arthur"][#"Work"] := "Software Developer"
51 | *
52 | * // Start a new Associative Array and set values
53 | * aaFriends[#"David"] := Array(#)
54 | * aaFriends[#"David"][#"Name"] := "David"
55 | * aaFriends[#"David"][#"Account"] := 187204
56 | * aaFriends[#"David"][#"Work"] := "Web Designer"
57 | *
58 | * // Let's do something interesting:
59 | *
60 | * aaFriends[#"David"][#"Best Friend"] := aaFriends[#"Arthur"]
61 | *
62 | * // And test it:
63 | *
64 | * Alert (aaFriends[#"David"][#"Best Friend"][#"Name"])
65 | * Alert (aaFriends[#"David"][#"Best Friend"][#"Work"])
66 | *
67 | * // We can also mix it with the regular Array:
68 | * aaFriends[#"Arthur"][#"Friends"] := Array(1)
69 | * aaFriends[#"Arthur"][#"Friends"][1] := aaFriends[#"David"]
70 | *
71 | * Alert (aaFriends[#"Arthur"][#"Friends"][1][#"Name"])
72 | *
73 | *
74 | * -- How does it work on the background?
75 | *
76 | * When we create an Associative Array, we are in reality instantiating
77 | * a Class and creating an Object.
78 | *
79 | * Take a look at it working, this:
80 | * aaFriends := Array(#)
81 | * aaFriends[#"David"] := Array(#)
82 | * aaFriends[#"David"][#"Account"] := 187204
83 | *
84 | * is translated to this by the precompiler:
85 | * aaFriends := SHash():New()
86 | * aaFriends:Set("David", SHash():New())
87 | * aaFriends:Get("David"):Set("Account", 187204)
88 | *
89 | * The SHash object has the aData array that stores all the data, so you
90 | * can easily access all the data thought a loop:
91 | *
92 | * For i := 1 to len(aaFriends:aData)
93 | * QOut( aaFriends:aData[i][1] +': '+ aaFriends:aData[i][2] )
94 | * Next
95 | *
96 | \*----------------------------------------------------------------------*/
97 |
98 | #IFNDEF _AARRAY_CH
99 |
100 | #DEFINE _AARRAY_CH
101 |
102 | #IFNDEF __HARBOUR__
103 | #include "shash.ch"
104 |
105 | #xtranslate \[\#\] := => :Set(,)
106 | #xtranslate \[\#\] => :Get()
107 | #xtranslate Array(\#) => SHash():New()
108 | #ELSE
109 | #xtranslate \[\#\] := => \[\] :=
110 | #xtranslate \[\#\] => \[\]
111 | #xtranslate Array(\#) => \{\=\>\}
112 | #ENDIF
113 |
114 | #ENDIF
115 |
--------------------------------------------------------------------------------
/include/json.ch:
--------------------------------------------------------------------------------
1 | /*----------------------------------------------------------------------*\
2 | * JSON for AdvPL
3 | * Copyright (C) 2013 Arthur Helfstein Fragoso
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU Lesser General Public License as published
7 | * by the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU Lesser General Public License
16 | * along with this program. If not, see .
17 | *
18 | * This program includes the function JsonMinify that is a ported version
19 | * of JSONLint by Chris Dary. Here is his original license: (MIT License)
20 | *
21 | * Copyright (c) 2011 Chris Dary.
22 | *
23 | * Permission to use, copy, modify, and/or distribute this software for any
24 | * purpose with or without fee is hereby granted, provided that the above
25 | * copyright notice and this permission notice appear in all copies.
26 | *
27 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
28 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
29 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
30 | * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
31 | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
32 | * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
33 | * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
34 | *
35 | *----------------------------------------------------------------------*
36 | *
37 | * How to use this program:
38 | *
39 | * 1 - Add the files JSON.prg and SHash.prg to your project.
40 | *
41 | * 2 - Compile JSON.prg and SHash.prg.
42 | *
43 | * 3 - Include the header files to any project you want to use it:
44 | *
45 | * #Include "aarray.ch"
46 | * #Include "json.ch"
47 | *
48 | * 4 - See the functions documentation, it's very easy to use it. ;)
49 | *
50 | *
51 | * Note: Thanks to the preprocessor we can call user functions without
52 | * the U_, we just use the #xtranslate function, see bellow to understand
53 | * it.
54 | *
55 | \*----------------------------------------------------------------------*/
56 |
57 |
58 | #IFNDEF _JSON_CH
59 |
60 | #DEFINE _JSON_CH
61 |
62 |
63 | /**
64 | * (User) Function: FromJson(cJstr)
65 | * Converts from a JSON string into any value it holds
66 | *
67 | * Example:
68 | * ----
69 | * cJSON := '{"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 4e-1}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}'
70 | *
71 | * aaBusiness := FromJson(cJSON)
72 | *
73 | * alert(aaBusiness[#'Products'][1][#'Name']) // Returns -> Water
74 | *
75 | * alert(aaBusiness[#'Products'][2][#'Cost']) // Returns -> 0.4
76 | *
77 | * alert(aaBusiness[#'Users'][1][#'Comment']) // Returns -> Hello" \World
78 | * ----
79 | *
80 | * Additional Info:
81 | * * Numbers accept the Scientific E Notation
82 | * 234e-7 = 0.0000234
83 | * 57e3 = 57000
84 | * * I don't know how I can make an Unicode or UTF-8 character in Clipper/AdvPL,
85 | * So, the json \uXXXX converts an ASCII code. Values outside the ASCII table becomes '?' (quotation marks).
86 | *
87 | * @param cJstr - The JSON string you want to convert from
88 | * @return - The converted JSON string, it can be any type. Or Nil in case of a bad formatted JSON string.
89 | **/
90 |
91 | #xtranslate FromJson() => U_FromJson()
92 |
93 |
94 | /**
95 | * (User) Function: ToJson(uAnyVar)
96 | * Converts AdvPLs value into a JSON string
97 | * Accepted values: Strings, Numbers, Logicals, Nil, Arrays and Associative Arrays (SHash Objects)
98 | *
99 | * Example:
100 | * ----
101 | * aaBusiness := Array(#)
102 | * aaBusiness[#'Products'] := Array(2)
103 | * aaBusiness[#'Products'][1] := Array(#)
104 | * aaBusiness[#'Products'][1][#'Name'] := "Water"
105 | * aaBusiness[#'Products'][1][#'Cost'] := 1.3
106 | * aaBusiness[#'Products'][2] := Array(#)
107 | * aaBusiness[#'Products'][2][#'Name'] := "Bread"
108 | * aaBusiness[#'Products'][2][#'Cost'] := 0.4
109 | * aaBusiness[#'Users'] := Array(1)
110 | * aaBusiness[#'Users'][1] := Array(#)
111 | * aaBusiness[#'Users'][1][#'Name'] := "Arthur"
112 | * aaBusiness[#'Users'][1][#'Comment'] := 'Hello" \World'
113 | *
114 | *
115 | * alert( ToJson(aaBusiness) )
116 | *
117 | * // Returns:
118 | * {"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 0.4}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}
119 | * ----
120 | *
121 | * @param uAnyVar - The value you want to convert to a JSON string
122 | * @return string - JSON string
123 | **/
124 |
125 | #xtranslate ToJson() => U_ToJson()
126 |
127 |
128 | /**
129 | * (User) Function: EscpJsonStr(cJsStr)
130 | * Escapes string to a JSON string format
131 | * ToJson() Automatically escapes strings, there is no much use of this function unless
132 | * you want to write the JSON strings yourself.
133 | *
134 | * Example:
135 | * ----
136 | * cProdName := 'Cool" and \ cool"'
137 | *
138 | * cJSON := '{"Product": {"Name": "'+ EscpJsonStr(cProdName) +'"}}'
139 | *
140 | * alert( JsonPrettify(cJSON) ) // -> {"Product": {"Name": "Cool\" and \\ cool\""}}
141 | * ----
142 | *
143 | * @param cJsStr - The String you want to escape
144 | * @return cJsStr - Escaped JSON string
145 | **/
146 |
147 | #xtranslate EscpJsonStr() => U_EscpJsonStr()
148 |
149 |
150 | /**
151 | * (User) Function: JsonPrettify(cJstr [,nTab])
152 | * Prettify a JSON string. It will indent and make it more readable
153 | *
154 | * Example:
155 | * -----
156 | * cJSON := '{"Products": [{"Name": "Water", "Cost": 1.30}, {"Name": "Bread", "Cost": 0.40}]}'
157 | *
158 | * alert( JsonPrettify(cJSON, 4) )
159 | *
160 | * Result:
161 | *
162 | * {
163 | * "Products": [
164 | * {
165 | * "Name": "Water",
166 | * "Cost": 1.30
167 | * },
168 | * {
169 | * "Name": "Bread",
170 | * "Cost": 0.40
171 | * }
172 | * ]
173 | * }
174 | * ----
175 | *
176 | * @param cJstr - The JSON string to prettify
177 | * @param nTab (optional) - number of spaces for each indentation, -1 for tabs (\t) (Default: -1)
178 | * @return string - Prettified JSON string
179 | **/
180 |
181 | #xtranslate JsonPrettify( [,]) => U_JsonPrettify(, )
182 |
183 |
184 | /**
185 | * (User) Function: JsonMinify(cJstr)
186 | * Remove spaces, breaklines, and comments
187 | *
188 | * Comments are not allowed in the JSON specification, but we can remove them with this function.
189 | * Allowed comments:
190 | *
191 | * // Single line comment
192 | *
193 | * /* Multiple Lines
194 | * Multiple Lines
195 | * Multiple Lines */
196 | /*
197 | * Example:
198 | * -----
199 | * cJSON := '{' + CRLF
200 | * cJSON += ' // this is a comment' + CRLF
201 | * cJSON += ' "Products": [35, 50]' + CRLF
202 | * cJSON += '}'
203 | *
204 | * cJSON := JsonMinify(cJSON) // -> returns '{"Products":[35,50]}'
205 | * -----
206 | *
207 | * Function ported from Chris Dary's JSONLint:
208 | * http://jsonlint.com/c/js/jsl.format.js
209 | * https://github.com/arc90/jsonlintdotcom/blob/master/c/js/jsl.format.js
210 | *
211 | * A copy of his license should be at the top of this file.
212 | *
213 | * @param cJstr - The JSON string to Minify
214 | * @return string - Minified JSON string
215 | **/
216 |
217 | #xtranslate JsonMinify() => U_JsonMinify()
218 |
219 |
220 | /**
221 | * (User) Function: ReadJsonFile(cFileName [,lStripComments])
222 | * Reads JSON from a JSON file.
223 | *
224 | * Example:
225 | * -----
226 | * aaConf := ReadJsonFile("D:\TOTVS\Config.json")
227 | * alert(aaConf[#'Product'][35][#'name'])
228 | * -----
229 | *
230 | * @param cFileName - Filename
231 | * @param lStripComments (Optional) - .T. removes comments, .F. doesn't. (Default .T.)
232 | * @return AnyValue - Returns the value of the JSON file
233 | **/
234 |
235 | #xtranslate ReadJsonFile( [,]) => U_ReadJsonFile(, )
236 |
237 |
238 |
239 | // ASCII Characteres
240 |
241 | #DEFINE CHR_BS chr(8)
242 | #DEFINE CHR_HT chr(9)
243 | #DEFINE CHR_LF chr(10)
244 | #DEFINE CHR_VT chr(11)
245 | #DEFINE CHR_FF chr(12)
246 | #DEFINE CHR_CR chr(13)
247 | #DEFINE CRLF chr(13)+chr(10)
248 |
249 | #IFNDEF __HARBOUR__
250 | #Include "Protheus.ch"
251 | #ELSE
252 | #xcommand DEFAULT := ;
253 | [, := ] => ;
254 | := If( == nil, , ) ;;
255 | [ := If( == nil, , ); ]
256 | #xcommand BEGIN SEQUENCE =>
257 | #xcommand END SEQUENCE =>
258 | #xtranslate CVALTOCHAR() => AllTrim(str())
259 | #ENDIF
260 |
261 | #ENDIF
262 |
--------------------------------------------------------------------------------
/include/shash.ch:
--------------------------------------------------------------------------------
1 | /*----------------------------------------------------------------------*\
2 | * SHASH - A Simple Hash (Associative Array) for AdvPL
3 | * Copyright (C) 2013 Arthur Helfstein Fragoso
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU Lesser General Public License as published
7 | * by the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU Lesser General Public License
16 | * along with this program. If not, see .
17 | *
18 | * The SHASH class is an adapted version of Marinaldo de Jesus' THASH Class.
19 | *
20 | \*----------------------------------------------------------------------*/
21 |
22 | #IFNDEF _SHASH_CH
23 |
24 | #DEFINE _SHASH_CH
25 |
26 | /*/
27 | Arquivo: SHASH.CH
28 | Autor: Marinaldo de Jesus
29 | Data: 04/12/2011
30 | Descricao: Arquivo de Cabecalho utilizado na Classe SHASH e derivadas
31 | Sintaxe: #INCLUDE "SHASH.CH"
32 | /*/
33 |
34 | #DEFINE SPROPERTY_KEY 1
35 | #DEFINE SPROPERTY_VALUE 2
36 | #DEFINE SPROPERTY_ELEMENTS 2
37 |
38 | #ENDIF
39 |
--------------------------------------------------------------------------------
/lib/JSON.prg:
--------------------------------------------------------------------------------
1 | /*----------------------------------------------------------------------*\
2 | * JSON for AdvPL
3 | * Copyright (C) 2013 Arthur Helfstein Fragoso
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU Lesser General Public License as published
7 | * by the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU Lesser General Public License
16 | * along with this program. If not, see .
17 | *
18 | * This program includes the function JsonMinify that is a ported version
19 | * of JSONLint by Chris Dary. Here is his original license: (MIT License)
20 | *
21 | * Copyright (c) 2011 Chris Dary.
22 | *
23 | * Permission to use, copy, modify, and/or distribute this software for any
24 | * purpose with or without fee is hereby granted, provided that the above
25 | * copyright notice and this permission notice appear in all copies.
26 | *
27 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
28 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
29 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
30 | * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
31 | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
32 | * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
33 | * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
34 | *
35 | *----------------------------------------------------------------------*
36 | *
37 | * How to use this program:
38 | *
39 | * 1 - Add the files JSON.prg and SHash.prg to your project.
40 | *
41 | * 2 - Compile JSON.prg and SHash.prg.
42 | *
43 | * 3 - Include the header files to any project you want to use it:
44 | *
45 | * #Include "aarray.ch"
46 | * #Include "json.ch"
47 | *
48 | * 4 - See the functions documentation, it's very easy to use it. ;)
49 | *
50 | *
51 | * Note: Thanks to the preprocessor we can call user functions without
52 | * the U_, look at the aarray.ch header file to understand it better.
53 | *
54 | \*----------------------------------------------------------------------*/
55 |
56 | #Include "aarray.ch"
57 | #Include "json.ch"
58 |
59 |
60 | /**
61 | * (User) Function: FromJson(cJstr)
62 | * Converts from a JSON string into any value it holds
63 | *
64 | * Example:
65 | * ----
66 | * cJSON := '{"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 4e-1}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}'
67 | *
68 | * aaBusiness := FromJson(cJSON)
69 | *
70 | * alert(aaBusiness[#'Products'][1][#'Name']) // Returns -> Water
71 | *
72 | * alert(aaBusiness[#'Products'][2][#'Cost']) // Returns -> 0.4
73 | *
74 | * alert(aaBusiness[#'Users'][1][#'Comment']) // Returns -> Hello" \World
75 | * ----
76 | *
77 | * Additional Info:
78 | * * Numbers accept the Scientific E Notation
79 | * 234e-7 = 0.0000234
80 | * 57e3 = 57000
81 | * * I don't know how I can make an Unicode or UTF-8 character in AdvPL,
82 | * So, the json \uXXXX converts an ASCII code. Values outside the ASCII table becomes '?' (quotation marks).
83 | *
84 | * @param cJstr - The JSON string you want to convert from
85 | * @return - The converted JSON string, it can be any type. Or Nil in case of a bad formatted JSON string.
86 | **/
87 |
88 | Function FromJson(cJstr)
89 | Return GetJsonVal(cJstr)[1]
90 |
91 |
92 |
93 |
94 |
95 | /**
96 | * (User) Function: ToJson(uAnyVar)
97 | * Converts AdvPLs value into a JSON string
98 | * Accepted values: Strings, Numbers, Logicals, Nil, Arrays and Associative Arrays (SHash Objects)
99 | *
100 | * Example:
101 | * ----
102 | * aaBusiness := Array(#)
103 | * aaBusiness[#'Products'] := Array(2)
104 | * aaBusiness[#'Products'][1] := Array(#)
105 | * aaBusiness[#'Products'][1][#'Name'] := "Water"
106 | * aaBusiness[#'Products'][1][#'Cost'] := 1.3
107 | * aaBusiness[#'Products'][2] := Array(#)
108 | * aaBusiness[#'Products'][2][#'Name'] := "Bread"
109 | * aaBusiness[#'Products'][2][#'Cost'] := 0.4
110 | * aaBusiness[#'Users'] := Array(1)
111 | * aaBusiness[#'Users'][1] := Array(#)
112 | * aaBusiness[#'Users'][1][#'Name'] := "Arthur"
113 | * aaBusiness[#'Users'][1][#'Comment'] := 'Hello" \World'
114 | *
115 | *
116 | * alert( ToJson(aaBusiness) )
117 | *
118 | * // Returns:
119 | * {"Products": [{"Name": "Water", "Cost": 1.3}, {"Name": "Bread", "Cost": 0.4}], "Users": [{"Name": "Arthur", "Comment": "Hello\" \\World"}]}
120 | * ----
121 | *
122 | * @param uAnyVar - The value you want to convert to a JSON string
123 | * @return string - JSON string
124 | **/
125 |
126 | Function ToJson (uAnyVar)
127 | Local cRet, nI, cType, aAsKeys
128 |
129 | cType := valType(uAnyVar)
130 | DO CASE
131 | case cType == "C"
132 | return '"'+ EscpJsonStr(uAnyVar) +'"'
133 | case cType == "N"
134 | return CvalToChar(uAnyVar)
135 | case cType == "L"
136 | return if(uAnyVar,"true","false")
137 | case cType == "D"
138 | return '"'+ DtoS(uAnyVar) +'"'
139 | case cType == "U"
140 | return "null"
141 | case cType == "A"
142 | cRet := '['
143 | For nI := 1 to len(uAnyVar)
144 | if(nI != 1)
145 | cRet += ', '
146 | endif
147 | cRet += ToJson(uAnyVar[nI])
148 | Next
149 | return cRet + ']'
150 | case cType == "B"
151 | return '"Type Block"'
152 | case cType == "M"
153 | return '"Type Memo"'
154 | case cType =="O"
155 | if uAnyVar:cClassName == "SHASH"
156 | cRet := '{'
157 | For nI := 1 to len(uAnyVar:aData)
158 | if(nI != 1)
159 | cRet += ', '
160 | endif
161 | cRet += '"'+ EscpJsonStr(uAnyVar:aData[nI][SPROPERTY_KEY]) +'": '+ ToJson(uAnyVar:aData[nI][SPROPERTY_VALUE])
162 | Next
163 | return cRet + '}'
164 | endif
165 | return '"Type Object"'
166 | #IFDEF __HARBOUR__
167 | case cType =="H" //Harbour Associative Array
168 | aAsKeys := hb_hkeys(uAnyVar)
169 | cRet := '{'
170 | For nI := 1 to len(aAsKeys)
171 | if(nI != 1)
172 | cRet += ', '
173 | endif
174 | cRet += '"'+ EscpJsonStr(aAsKeys[nI]) +'": '+ ToJson(uAnyVar[aAsKeys[nI]])
175 | Next
176 | return cRet + '}'
177 | #ENDIF
178 | ENDCASE
179 | Return '"Unknown Data Type ('+ cType +')"'
180 |
181 |
182 | /**
183 | * (User) Function: EscpJsonStr(cJsStr)
184 | * Escapes string to a JSON string format
185 | * ToJson() Automatically escapes strings, there is no much use of this function unless
186 | * you want to write the JSON strings yourself.
187 | *
188 | * Example:
189 | * ----
190 | * cProdName := 'Cool" and \ cool"'
191 | *
192 | * cJSON := '{"Product": {"Name": "'+ EscpJsonStr(cProdName) +'"}}'
193 | *
194 | * alert( JsonPrettify(cJSON) ) // -> {"Product": {"Name": "Cool\" and \\ cool\""}}
195 | * ----
196 | *
197 | * @param cJsStr - The String you want to escape
198 | * @return cJsStr - Escaped JSON string
199 | **/
200 |
201 | Function EscpJsonStr(cJsStr)
202 | cJsStr := StrTran(cJsStr, '\', '\\') // we must escape \ first, so it won't bug the rest
203 | cJsStr := StrTran(cJsStr, '"', '\"')
204 | cJsStr := StrTran(cJsStr, CHR_FF, '\f')
205 | cJsStr := StrTran(cJsStr, CHR_LF, '\n')
206 | cJsStr := StrTran(cJsStr, CHR_CR, '\r')
207 | cJsStr := StrTran(cJsStr, CHR_HT, '\t')
208 | Return cJsStr
209 |
210 |
211 | /**
212 | * (User) Function: JsonPrettify(cJstr [,nTab])
213 | * Prettify a JSON string. It will indent and make it more readable
214 | *
215 | * Example:
216 | * -----
217 | * cJSON := '{"Products": [{"Name": "Water", "Cost": 1.30}, {"Name": "Bread", "Cost": 0.40}]}'
218 | *
219 | * alert( JsonPrettify(cJSON, 4) )
220 | *
221 | * Result:
222 | *
223 | * {
224 | * "Products": [
225 | * {
226 | * "Name": "Water",
227 | * "Cost": 1.30
228 | * },
229 | * {
230 | * "Name": "Bread",
231 | * "Cost": 0.40
232 | * }
233 | * ]
234 | * }
235 | * ----
236 | *
237 | * @param cJstr - The JSON string to prettify
238 | * @param nTab (opitional) - number of spaces for each indentation, -1 for tabs (\t) (Default: -1)
239 | * @return string - Prettified JSON string
240 | **/
241 |
242 | Function JsonPrettify(cJstr, nTab)
243 | Local nConta, cBefore, cTab
244 | Local cLetra := ""
245 | Local lInString := .F.
246 | Local cNewJsn := ""
247 | Local nIdentLev := 0
248 | Default nTab := -1
249 |
250 | if nTab > 0
251 | cTab := REPLICATE(" ", nTab)
252 | else
253 | cTab := CHR_HT
254 | endif
255 |
256 |
257 | For nConta:= 1 To Len(cJstr)
258 |
259 | cBefore := cLetra
260 | cLetra := SubStr(cJstr, nConta, 1)
261 |
262 | if cLetra == "{" .or. cLetra == "["
263 | if !lInString
264 | nIdentLev++
265 | cNewJsn += cLetra + CRLF + REPLICATE( cTab, nIdentLev)
266 | else
267 | cNewJsn += cLetra
268 | endif
269 | elseif cLetra == "}" .or. cLetra == "]"
270 | if !lInString
271 | nIdentLev--
272 | cNewJsn += CRLF + REPLICATE(cTab, nIdentLev) + cLetra
273 | else
274 | cNewJsn += cLetra
275 | endif
276 | elseif cLetra == ","
277 | if !lInString
278 | cNewJsn += cLetra + CRLF + REPLICATE(cTab, nIdentLev)
279 | else
280 | cNewJsn += cLetra
281 | endif
282 | elseif cLetra == ":"
283 | if !lInString
284 | cNewJsn += ": "
285 | else
286 | cNewJsn += cLetra
287 | endif
288 | elseif cLetra == " " .or. cLetra == CHR_LF .or. cLetra == CHR_HT
289 | if lInString
290 | cNewJsn += cLetra
291 | endif
292 | elseif cLetra == '"'
293 | if cBefore != "\"
294 | lInString := !lInString
295 | endif
296 | cNewJsn += cLetra
297 | else
298 | cNewJsn += cLetra
299 | endif
300 | Next
301 | Return cNewJsn
302 |
303 |
304 | /**
305 | * (User) Function: JsonMinify(cJstr)
306 | * Remove spaces, breaklines, and comments
307 | *
308 | * Comments are not allowed in the JSON specification, but we can remove them with this function.
309 | * Allowed comments:
310 | *
311 | * // Single line comment
312 | *
313 | * /* Multiple Lines
314 | * Multiple Lines
315 | * Multiple Lines */
316 | /*
317 | * Example:
318 | * -----
319 | * cJSON := '{' + CRLF
320 | * cJSON += ' // this is a comment' + CRLF
321 | * cJSON += ' "Products": [35, 50]' + CRLF
322 | * cJSON += '}'
323 | *
324 | * cJSON := JsonMinify(cJSON) // -> returns '{"Products":[35,50]}'
325 | * -----
326 | *
327 | * Function ported from Chris Dary's JSONLint:
328 | * http://jsonlint.com/c/js/jsl.format.js
329 | * https://github.com/arc90/jsonlintdotcom/blob/master/c/js/jsl.format.js
330 | *
331 | * A copy of his license should be at the top of this file.
332 | *
333 | * @param cJstr - The JSON string to Minify
334 | * @return string - Minified JSON string
335 | **/
336 |
337 | Function JsonMinify(cJstr)
338 | Local nConta, cBefore
339 | Local cLetra := ""
340 | Local lInString := .F.
341 | Local cNewJsn := ""
342 | Local lInLineCommt := .F.
343 | Local lMultLineCommt := .F.
344 |
345 | For nConta:= 1 To Len(cJstr)
346 |
347 | cBefore := cLetra
348 | cLetra := SubStr(cJstr, nConta, 1)
349 |
350 | // strip comments
351 | if lInLineCommt
352 | if cLetra == CHR_LF // \n
353 | lInLineCommt := .F.
354 | endif
355 | elseif lMultLineCommt
356 | if cBefore == "*" .and. cLetra == "/"
357 | lMultLineCommt := .F.
358 | endif
359 | elseif !lInString .and. cLetra == "/" .and. SubStr(cJstr, nConta+1, 1) == "/"
360 | lInLineCommt := .T.
361 | elseif !lInString .and. cLetra == "/" .and. SubStr(cJstr, nConta+1, 1) == "*"
362 | lMultLineCommt := .T.
363 |
364 | // real json
365 | elseif cLetra == "{" .or. cLetra == "["
366 | cNewJsn += cLetra
367 | elseif cLetra == "}" .or. cLetra == "]"
368 | cNewJsn += cLetra
369 | elseif cLetra == ","
370 | cNewJsn += cLetra
371 | elseif cLetra == ":"
372 | cNewJsn += cLetra
373 | elseif cLetra == " " .or. cLetra == CHR_LF .or. cLetra == CHR_HT .or. cLetra == CHR_CR
374 | if lInString
375 | cNewJsn += cLetra
376 | endif
377 | elseif cLetra == '"'
378 | if cBefore != "\"
379 | lInString := !lInString
380 | endif
381 | cNewJsn += cLetra
382 | else
383 | cNewJsn += cLetra
384 | endif
385 | Next
386 | Return cNewJsn
387 |
388 |
389 | /**
390 | * (User) Function: ReadJsonFile(cFileName [,lStripComments])
391 | * Reads JSON from a JSON file.
392 | *
393 | * Example:
394 | * -----
395 | * aaConf := ReadJsonFile("D:\TOTVS\Config.json")
396 | * alert(aaConf[#'Product'][35][#'name'])
397 | * -----
398 | *
399 | * @param cFileName - Filename
400 | * @param lStripComments (Optional) - .T. removes comments, .F. doesn't. (Default .T.)
401 | * @return AnyValue - Returns the value of the JSON file
402 | **/
403 |
404 | Function ReadJsonFile(cFileName, lStripComments)
405 | Default lStripComments := .T.
406 | if !File(cFileName)
407 | Return Nil
408 | endif
409 |
410 | if lStripComments
411 | Return FromJson(JsonMinify(MemoRead(cFileName, .F.)))
412 | else
413 | Return FromJson(MemoRead(cFileName, .F.))
414 | endif
415 | Return
416 |
417 |
418 |
419 | /// End of User Functions
420 |
421 |
422 | ////////////////////////////////////////////////////////////////////////////////////////////////////////
423 | // Bellow there are only internal functions which are necessary for the FromJson function
424 |
425 | /// Begin of Internal Functions
426 |
427 |
428 |
429 | /**
430 | * Internal Function: GetJsonVal(cJstr)
431 | * Converts from a JSON string into any value it holds
432 | *
433 | * @param cJstr - The JSON string you want to convert from
434 | * @return array(
435 | * uVal, - Value of the converted JSON string, or Nil in case of a bad formatted JSON string.
436 | * nPos - Position of the last processed character. Returns -1 in case of a bad formatted JSON string.
437 | * )
438 | **/
439 |
440 | Static Function GetJsonVal(cJstr)
441 | Local nConta
442 | Local cLetra := ""
443 | Local aTmp
444 |
445 | BEGIN SEQUENCE
446 |
447 | For nConta:= 1 To Len(cJstr)
448 |
449 | cLetra := SubStr(cJstr, nConta, 1)
450 |
451 | if cLetra == '"'
452 | aTmp := JsonStr(SubStr(cJstr, nConta))
453 | BREAK
454 | elseif at(cLetra, "0123456789.-") > 0
455 | aTmp := JsonNum(SubStr(cJstr, nConta))
456 | BREAK
457 | elseif cLetra == "["
458 | aTmp := JsonArr(SubStr(cJstr, nConta))
459 | BREAK
460 | elseif cLetra == "{"
461 | aTmp := JsonObj(SubStr(cJstr, nConta))
462 | BREAK
463 | elseif at(cLetra, "TtFfNn") > 0 //True, False or Null
464 | aTmp := JsonTFN(SubStr(cJstr, nConta))
465 | BREAK
466 | endif
467 |
468 | Next
469 |
470 | END SEQUENCE
471 |
472 | if len(aTmp) > 0
473 | if aTmp[2] < 0
474 | return {Nil, -1} // Error Code
475 | endif
476 |
477 | return {aTmp[1], nConta + aTmp[2] -1}
478 |
479 | endif
480 |
481 | Return {Nil, -1}
482 |
483 |
484 | /**
485 | * Internal Function: JsonArr(cJstr)
486 | * Converts from a JSON string containing only an Array into an Array
487 | *
488 | * @param cJstr - The JSON string you want to convert from
489 | * @return array(
490 | * aVal, - Value of the JSON array, or Nil in case of a bad formatted JSON string.
491 | * nPos - Position of the last processed character. Returns -1 in case of a bad formatted JSON string.
492 | * )
493 | **/
494 |
495 | Static Function JsonArr(cJstr)
496 | Local nConta
497 | Local cLetra := ""
498 | Local lNeedComma := .F.
499 | Local aRet := {}
500 | Local aTmp
501 |
502 | BEGIN SEQUENCE
503 |
504 | For nConta:= 2 To Len(cJstr)
505 |
506 | cLetra := SubStr(cJstr, nConta, 1)
507 |
508 | if !lNeedComma .and. at(cLetra, '"{[0123456789.-') > 0
509 | aTmp := GetJsonVal(SubStr(cJstr, nConta))
510 | if aTmp[2] < 0
511 | return {Nil, -1} // Error Code
512 | endif
513 | AADD(aRet, aTmp[1])
514 | nConta := nConta + aTmp[2] -1 // -1 move to last character because the loop will add +1.
515 | lNeedComma := .T.
516 | elseif lNeedComma .and. cLetra == ','
517 | lNeedComma := .F.
518 | elseif cLetra == ']'
519 | return {aRet, nConta}
520 | endif
521 |
522 | Next
523 |
524 | END SEQUENCE
525 |
526 | Return {Nil, -1}
527 |
528 |
529 | /**
530 | * Internal Function: JsonObj(cJstr)
531 | * Converts from a JSON string containing only an Object into an Associative Array (SHash Object)
532 | *
533 | * @param cJstr - The JSON string you want to convert from
534 | * @return array(
535 | * aaVal, - Associative Array (SHash Object) of the JSON object, or Nil in case of a bad formatted JSON string.
536 | * nPos - Position of the last processed character. Returns -1 in case of a bad formatted JSON string.
537 | * )
538 | **/
539 |
540 | Static Function JsonObj(cJstr)
541 | Local nConta
542 | Local cLetra := ""
543 | Local cTmpStr := ""
544 | Local nStep := 1
545 | Local aTmp
546 | Local aaRet := array(#)
547 |
548 | BEGIN SEQUENCE
549 |
550 | For nConta:= 2 To Len(cJstr)
551 |
552 | cLetra := SubStr(cJstr, nConta, 1)
553 |
554 | if nStep == 1 .and. cLetra == '"'
555 | aTmp := JsonStr(SubStr(cJstr, nConta))
556 | if aTmp[2] < 0
557 | return {Nil, -1} // Error Code
558 | endif
559 | nConta := nConta + aTmp[2] -1
560 | cTmpStr := aTmp[1]
561 | nStep := 2
562 |
563 | elseif nStep == 2 .and. cLetra == ':'
564 | nStep := 3
565 |
566 | elseif nStep == 3 .and. at(cLetra, '"{[0123456789.-TtFfNn') > 0
567 | aTmp := GetJsonVal(SubStr(cJstr, nConta))
568 | if aTmp[2] < 0
569 | return {Nil, -1} // Error Code
570 | endif
571 | nConta := nConta + aTmp[2] -1
572 | nStep := 4
573 | elseif nStep == 4 .and. cLetra == ','
574 | aaRet[#cTmpStr] := aTmp[1]
575 | nStep := 1
576 | elseif nStep == 4 .and. cLetra == '}'
577 | aaRet[#cTmpStr] := aTmp[1]
578 | return {aaRet, nConta}
579 | endif
580 |
581 | Next
582 |
583 | END SEQUENCE
584 |
585 | Return {Nil, -1}
586 |
587 |
588 | /**
589 | * Internal Function: JsonStr(cJstr)
590 | * Converts from a JSON string containing only a String into a String
591 | *
592 | * @param cJstr - The JSON string you want to convert from
593 | * @return array(
594 | * cVal, - Value of the JSON string, or Nil in case of a bad formatted JSON string.
595 | * nPos - Position of the last processed character. Returns -1 in case of a bad formatted JSON string.
596 | * )
597 | **/
598 |
599 | Static Function JsonStr(cJstr)
600 | Local nConta
601 | Local cLetra := ""
602 | Local cTmpStr := ""
603 | Local nUnic
604 |
605 | BEGIN SEQUENCE
606 |
607 | For nConta:= 2 To Len(cJstr)
608 |
609 | cLetra := SubStr(cJstr, nConta, 1)
610 |
611 | if cLetra == "\"
612 | nConta++
613 | cLetra := SubStr(cJstr, nConta, 1)
614 | if cLetra == 'b'
615 | cTmpStr += CHR_BS
616 | elseif cLetra == 'f'
617 | cTmpStr += CHR_FF
618 | elseif cLetra == 'n'
619 | cTmpStr += CHR_LF
620 | elseif cLetra == 'r'
621 | cTmpStr += CHR_CR
622 | elseif cLetra == 't'
623 | cTmpStr += CHR_HT
624 | elseif cLetra == 'u'
625 | nUnic := CTON(UPPER(SubStr(cJstr, nConta+1, 4)),16)
626 | if nUnic <= 255
627 | cTmpStr += chr(nUnic)
628 | else
629 | cTmpStr += '?'
630 | endif
631 | nConta += 4
632 | else
633 | cTmpStr += cLetra //it will add the char if it doesn't have a special function
634 | endif
635 |
636 | elseif cLetra == '"'
637 | return {cTmpStr, nConta}
638 | else
639 | cTmpStr += cLetra
640 | endif
641 |
642 | Next
643 |
644 | END SEQUENCE
645 |
646 | Return {Nil, -1}
647 |
648 |
649 | /**
650 | * Internal Function: JsonNum(cJstr)
651 | * Converts from a JSON string containing only a Number into a Number
652 | * It accepts the (Scientific) E Notation
653 | *
654 | * @param cJstr - The JSON string you want to convert from
655 | * @return array(
656 | * nVal, - Value of the JSON number, or Nil in case of a bad formatted JSON string.
657 | * nPos - Position of the last processed character. Returns -1 in case of a bad formatted JSON string.
658 | * )
659 | **/
660 |
661 | Static Function JsonNum(cJstr)
662 | Local nConta, nNum, aTmp
663 | Local cLetra := ""
664 | Local cTmpStr := ""
665 | Local lNegExp := .F.
666 |
667 | BEGIN SEQUENCE
668 |
669 | For nConta:= 1 To Len(cJstr)
670 |
671 | cLetra := SubStr(cJstr, nConta, 1)
672 |
673 | if at(cLetra, '0123456789.-') > 0
674 | cTmpStr += cLetra
675 |
676 | elseif len(cLetra) > 0 .and. UPPER(cLetra) == 'E'
677 | nNum := val(cTmpStr)
678 | cTmpStr := ""
679 | nConta++
680 | cLetra := SubStr(cJstr, nConta, 1)
681 | if cLetra == '-'
682 | lNegExp := .T.
683 | nConta++
684 | elseif cLetra == '+'
685 | nConta++
686 | endif
687 | cLetra := SubStr(cJstr, nConta, 1)
688 |
689 | while at(cLetra, '0123456789') > 0
690 | cTmpStr += cLetra
691 | nConta++
692 | cLetra := SubStr(cJstr, nConta, 1)
693 | end
694 |
695 | if lNegExp
696 | //nNum := nNum / val('1'+REPLICATE( '0', val(cTmpStr) ))
697 | if val(cTmpStr) != 0
698 | nNum := nNum * val('0.'+REPLICATE( '0', val(cTmpStr)-1) + '1')
699 | endif
700 | else
701 | nNum := nNum * val('1'+REPLICATE( '0', val(cTmpStr) ))
702 | endif
703 |
704 | return {nNum, nConta-1}
705 |
706 | elseif len(cLetra) > 0
707 | return {val(cTmpStr), nConta-1}
708 | endif
709 |
710 | Next
711 |
712 | END SEQUENCE
713 |
714 | Return {Nil, -1}
715 |
716 |
717 | /**
718 | * Internal Function: JsonTFN(cJstr)
719 | * Converts from a JSON string containing only a logical True, False or Null
720 | *
721 | * @param cJstr - The JSON string you want to convert from
722 | * @return array(
723 | * lVal, - Value of the JSON logical value, or Nil in case of Null or a bad formatted JSON string.
724 | * nPos - Position of the last processed character. Returns -1 in case of a bad formatted JSON string.
725 | * )
726 | **/
727 |
728 | Static Function JsonTFN(cJstr)
729 | Local cTmpStr
730 |
731 | BEGIN SEQUENCE
732 |
733 | cTmpStr := lower(SubStr(cJstr, 1, 5))
734 |
735 | if cTmpStr == "false"
736 | return {.F., 5}
737 | endif
738 |
739 | cTmpStr := SubStr(cTmpStr, 1, 4)
740 |
741 | if cTmpStr == "true"
742 | return {.T., 4}
743 | elseif cTmpStr == "null"
744 | return {Nil, 4}
745 | endif
746 |
747 | END SEQUENCE
748 |
749 | Return {Nil, -1}
750 |
751 |
--------------------------------------------------------------------------------
/lib/SHash.prg:
--------------------------------------------------------------------------------
1 | /*----------------------------------------------------------------------*\
2 | * SHASH - A Simple Hash (Associative Array) for AdvPL
3 | * Copyright (C) 2013 Arthur Helfstein Fragoso
4 | *
5 | * This program is free software: you can redistribute it and/or modify
6 | * it under the terms of the GNU Lesser General Public License as published
7 | * by the Free Software Foundation, either version 3 of the License, or
8 | * (at your option) any later version.
9 | *
10 | * This program is distributed in the hope that it will be useful,
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | * GNU General Public License for more details.
14 | *
15 | * You should have received a copy of the GNU Lesser General Public License
16 | * along with this program. If not, see .
17 | *
18 | * This class is an adapted version of Marinaldo de Jesus' THASH Class:
19 | *
20 | * https://code.google.com/p/totvs-AdvPL-naldodj/source/browse/trunk/templates/P10/ndj_01/Projeto/NDJLib/NDJLIB022.prg
21 | *
22 | * See the aarray.ch header file for instruction on how to use it.
23 | *
24 | \*----------------------------------------------------------------------*/
25 |
26 | #include "msobject.ch"
27 | #include "shash.ch"
28 |
29 | /*/
30 | CLASS: SHASH
31 | Autor: Marinaldo de Jesus
32 | Adaptado por: Arthur Helfstein Fragoso
33 | Descricao: Simple Hash, Associative Array
34 | Sintaxe: SHASH():New() -> Objeto do Tipo SHASH
35 | /*/
36 | CLASS SHASH
37 |
38 | DATA aData
39 | DATA cClassName
40 |
41 | METHOD NEW() CONSTRUCTOR
42 |
43 | METHOD ClassName()
44 |
45 | METHOD GetAt( uPropertyKey )
46 | METHOD Get( uPropertyKey , uDefaultValue )
47 | METHOD Set( uPropertyKey , uValue )
48 | METHOD Remove( uPropertyKey )
49 | METHOD GetAll( )
50 |
51 | ENDCLASS
52 |
53 | User Function SHASH()
54 | Return( SHASH():New() )
55 |
56 | /*/
57 | METHOD: New
58 | Autor: Marinaldo de Jesus
59 | Data: 04/12/2011
60 | Descricao: CONSTRUCTOR
61 | Sintaxe: SHASH():New() -> Self
62 | /*/
63 | METHOD New() CLASS SHASH
64 |
65 | Self:aData := Array( 0 )
66 | Self:cClassName := "SHASH"
67 |
68 | Return( Self )
69 |
70 | /*/
71 | METHOD: ClassName
72 | Autor: Marinaldo de Jesus
73 | Data: 04/12/2011
74 | Descricao: Retornar o Nome da Classe
75 | Sintaxe: SHASH():ClassName() -> cClassName
76 | /*/
77 | METHOD ClassName() CLASS SHASH
78 | Return( Self:cClassName )
79 |
80 | /*/
81 | METHOD: GetAt
82 | Autor: Marinaldo de Jesus
83 | Data: 04/12/2011
84 | Descricao: Obter a Posicao da Propriedade Passada por parametro e de acordo com a Secao
85 | Sintaxe: SHASH():GetAt( uPropertyKey ) -> nATProperty
86 | /*/
87 | METHOD GetAt( uPropertyKey ) CLASS SHASH
88 |
89 | Local nATProperty := 0
90 |
91 | BEGIN SEQUENCE
92 |
93 | nATProperty := aScan( Self:aData, { |aValues| ( Compare( aValues[ SPROPERTY_KEY ] , uPropertyKey ) ) } )
94 |
95 | END SEQUENCE
96 |
97 | Return( nATProperty )
98 |
99 | /*/
100 | METHOD: Get
101 | Autor: Marinaldo de Jesus
102 | Data: 04/12/2011
103 | Descricao: Obter o valor da Propriedade Passada por parametro e de acordo com a Secao
104 | Sintaxe: SHASH():Get( uPropertyKey , uDefaultValue ) -> uPropertyValue
105 | /*/
106 | METHOD Get( uPropertyKey , uDefaultValue ) CLASS SHASH
107 |
108 | Local uPropertyValue := "@__PROPERTY_NOT_FOUND__@"
109 |
110 | Local nProperty
111 |
112 | BEGIN SEQUENCE
113 |
114 | nProperty := Self:GetAt( @uPropertyKey )
115 | IF ( nProperty == 0 )
116 | BREAK
117 | EndIF
118 |
119 | uPropertyValue := Self:aData[ nProperty ][ SPROPERTY_VALUE ]
120 |
121 | END SEQUENCE
122 |
123 | IF ( Compare( uPropertyValue , "@__PROPERTY_NOT_FOUND__@" ) )
124 | IF !Empty( uDefaultValue )
125 | uPropertyValue := uDefaultValue
126 | Else
127 | uPropertyValue := NIL
128 | EndIF
129 | EndIF
130 |
131 | Return( uPropertyValue )
132 |
133 | /*/
134 | METHOD: AddNewProperty
135 | Autor: Marinaldo de Jesus
136 | Data: 04/12/2011
137 | Descricao: Adiciona ou Edita uma propriedade
138 | Sintaxe: SHASH():Set( uPropertyKey , uValue ) -> lSuccess
139 | /*/
140 | METHOD Set( uPropertyKey , uValue ) CLASS SHASH
141 |
142 | Local lSuccess := .F.
143 |
144 | Local nProperty
145 |
146 | BEGIN SEQUENCE
147 |
148 | nProperty := Self:GetAt( @uPropertyKey )
149 |
150 | IF ( nProperty == 0 )
151 | aAdd( Self:aData , Array( SPROPERTY_ELEMENTS ) )
152 | nProperty := Len( Self:aData )
153 | EndIF
154 |
155 | Self:aData[ nProperty ][ SPROPERTY_KEY ] := uPropertyKey
156 | Self:aData[ nProperty ][ SPROPERTY_VALUE ] := uValue
157 |
158 | lSuccess := .T.
159 |
160 | END SEQUENCE
161 |
162 | Return( lSuccess )
163 |
164 | /*/
165 | METHOD: Remove
166 | Autor: Marinaldo de Jesus
167 | Data: 04/12/2011
168 | Descricao: Remover Determinada Propriedade
169 | Sintaxe: SHASH():Remove( uPropertyKey ) -> lSuccess
170 | /*/
171 | METHOD Remove( uPropertyKey ) CLASS SHASH
172 |
173 | Local lSuccess := .F.
174 |
175 | Local nProperty
176 |
177 | BEGIN SEQUENCE
178 |
179 | nProperty := Self:GetAt( @uPropertyKey )
180 | IF ( nProperty == 0 )
181 | BREAK
182 | EndIF
183 |
184 | lSuccess := .T.
185 |
186 | aDel( Self:aData , nProperty )
187 | aSize( Self:aData , Len( Self:aData[ nSession ][ SPROPERTY_POSITION ] ) - 1 )
188 |
189 | END SEQUENCE
190 |
191 | Return( lSuccess )
192 |
193 | /*/
194 | METHOD: GetAll
195 | Autor: Marinaldo de Jesus
196 | Data: 04/12/2011
197 | Descricao: Retornar todas as propriedades
198 | Sintaxe: SHASH():GetAll( ) -> aAllProperties
199 | /*/
200 | METHOD GetAll() CLASS SHASH
201 | Return( Self:aData )
202 |
203 |
204 |
--------------------------------------------------------------------------------