Qore Programming Language  1.12.0
QoreListNode.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreListNode.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2022 Qore Technologies, s.r.o.
8 
9  Permission is hereby granted, free of charge, to any person obtaining a
10  copy of this software and associated documentation files (the "Software"),
11  to deal in the Software without restriction, including without limitation
12  the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  and/or sell copies of the Software, and to permit persons to whom the
14  Software is furnished to do so, subject to the following conditions:
15 
16  The above copyright notice and this permission notice shall be included in
17  all copies or substantial portions of the Software.
18 
19  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25  DEALINGS IN THE SOFTWARE.
26 
27  Note that the Qore library is released under a choice of three open-source
28  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
29  information.
30 */
31 
32 #ifndef _QORE_QORELISTNODE_H
33 
34 #define _QORE_QORELISTNODE_H
35 
36 #include <qore/AbstractQoreNode.h>
37 
38 #ifdef min
39 #undef min
40 #endif
41 #ifdef max
42 #undef max
43 #endif
44 
46 
48 
53  friend class StackList;
54  friend hashdecl qore_list_private;
55 
56 private:
58  DLLLOCAL QoreListNode(const QoreListNode&);
59 
61  DLLLOCAL QoreListNode& operator=(const QoreListNode&);
62 
63 protected:
65 
67  hashdecl qore_list_private *priv;
68 
70 
74  DLLEXPORT virtual ~QoreListNode();
75 
77 
83  DLLEXPORT virtual bool derefImpl(ExceptionSink* xsink);
84 
86 
89  DLLLOCAL virtual QoreValue evalImpl(bool& needs_deref, ExceptionSink* xsink) const;
90 
91 public:
93  DLLEXPORT QoreListNode();
94 
96  DLLEXPORT QoreListNode(const QoreTypeInfo* valueTypeInfo);
97 
99 
101  DLLEXPORT virtual bool getAsBoolImpl() const;
102 
104 
110  DLLEXPORT int getAsString(QoreString &str, int foff, ExceptionSink* xsink) const;
111 
113 
120  DLLEXPORT QoreString *getAsString(bool &del, int foff, ExceptionSink* xsink) const;
121 
123  //DLLEXPORT virtual bool needs_eval() const;
124 
126  DLLEXPORT virtual AbstractQoreNode* realCopy() const;
127 
129 
133  DLLEXPORT virtual bool is_equal_soft(const AbstractQoreNode* v, ExceptionSink* xsink) const;
134 
136 
140  DLLEXPORT virtual bool is_equal_hard(const AbstractQoreNode* v, ExceptionSink* xsink) const;
141 
143  DLLEXPORT virtual const char *getTypeName() const;
144 
146  //DLLEXPORT virtual bool is_value() const;
147 
148  DLLLOCAL static const char *getStaticTypeName() {
149  return "list";
150  }
151 
152  DLLEXPORT QoreValue& getEntryReference(size_t index);
153 
155 
159  DLLEXPORT QoreValue retrieveEntry(size_t index);
160 
162 
166  DLLEXPORT const QoreValue retrieveEntry(size_t index) const;
167 
169 
173  DLLEXPORT QoreValue getReferencedEntry(size_t index) const;
174 
176 
179  DLLEXPORT int getEntryAsInt(size_t index) const;
180 
182 
188  DLLEXPORT int setEntry(size_t index, QoreValue val, ExceptionSink* xsink);
189 
191 
193  DLLEXPORT int push(QoreValue val, ExceptionSink* xsink);
194 
196 
198  DLLEXPORT int insert(QoreValue val, ExceptionSink* xsink);
199 
201 
205  DLLEXPORT QoreValue pop();
206 
208 
213  DLLEXPORT QoreValue shift();
214 
216 
218  DLLEXPORT int merge(const QoreListNode* list, ExceptionSink* xsink);
219 
221 
227  DLLEXPORT QoreListNode* evalList(ExceptionSink* xsink) const;
228 
230 
237  DLLEXPORT QoreListNode* evalList(bool &needs_deref, ExceptionSink* xsink) const;
238 
240  DLLEXPORT QoreListNode* copy() const;
241 
243 
246  DLLEXPORT QoreListNode* copyListFrom(size_t index) const;
247 
249 
252  DLLEXPORT QoreListNode* sort(ExceptionSink* xsink) const;
253 
255 
259  DLLEXPORT QoreListNode* sort(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;
260 
262 
265  DLLEXPORT QoreListNode* sortStable(ExceptionSink* xsink) const;
266 
268 
272  DLLEXPORT QoreListNode* sortStable(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;
273 
275 
278  DLLEXPORT QoreListNode* sortDescending(ExceptionSink* xsink) const;
279 
281 
286 
288 
292 
294 
299 
301 
304  DLLEXPORT QoreValue min(ExceptionSink* xsink) const;
305 
307 
310  DLLEXPORT QoreValue max(ExceptionSink* xsink) const;
311 
313 
317  DLLEXPORT QoreValue min(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;
318 
320 
324  DLLEXPORT QoreValue max(const ResolvedCallReferenceNode* fr, ExceptionSink* xsink) const;
325 
327 
334  DLLEXPORT QoreListNode* splice(qore_offset_t offset);
335 
337 
345  DLLEXPORT QoreListNode* splice(qore_offset_t offset, qore_offset_t length);
346 
348 
359  DLLEXPORT QoreListNode* splice(qore_offset_t offset, qore_offset_t length, const QoreValue l, ExceptionSink* xsink);
360 
362 
367  DLLEXPORT QoreListNode* extract(qore_offset_t offset);
368 
370 
376  DLLEXPORT QoreListNode* extract(qore_offset_t offset, qore_offset_t length);
377 
379 
387  DLLEXPORT QoreListNode* extract(qore_offset_t offset, qore_offset_t length, const QoreValue l, ExceptionSink* xsink);
388 
390 
392  DLLEXPORT size_t size() const;
393 
395 
397  DLLEXPORT bool empty() const;
398 
400  DLLEXPORT QoreListNode* reverse() const;
401 
403  DLLEXPORT QoreListNode* listRefSelf() const;
404 
406 
408  DLLEXPORT const QoreTypeInfo* getValueTypeInfo() const;
409 
411 
413  DLLEXPORT const QoreTypeInfo* getTypeInfo() const;
414 
415  // needed only while parsing
417  DLLLOCAL QoreListNode(bool i);
418 
420  DLLLOCAL bool isFinalized() const;
421 
423  DLLLOCAL void setFinalized();
424 
426  DLLLOCAL bool isVariableList() const;
427 
429  DLLLOCAL void setVariableList();
430 
432  DLLLOCAL virtual int parseInit(QoreValue& val, QoreParseContext& parse_context);
433 };
434 
435 #include <qore/ReferenceHolder.h>
436 
438 
442 
444 
464 protected:
465  QoreListNode* l;
466  qore_offset_t pos;
467 
469  DLLLOCAL void *operator new(size_t);
470 
471 public:
473 
476  DLLEXPORT ListIterator(QoreListNode* lst, size_t n_pos = -1);
477 
479 
482  DLLEXPORT ListIterator(QoreListNode& lst, size_t n_pos = -1);
483 
485 
490  DLLEXPORT bool next();
491 
493 
499  DLLEXPORT bool prev();
500 
502 
507  DLLEXPORT int set(size_t n_pos);
508 
510 
512  DLLEXPORT QoreValue getReferencedValue() const;
513 
515  DLLEXPORT QoreValue getValue() const;
516 
518  DLLEXPORT bool first() const;
519 
521  DLLEXPORT bool last() const;
522 
524  DLLLOCAL size_t index() const { return pos; }
525 
527  DLLLOCAL size_t max() const { return l->size(); }
528 
530  DLLLOCAL QoreListNode* getList() { return l; }
531 
533  DLLLOCAL bool empty() const {
534  return l->empty();
535  }
536 
538  DLLLOCAL bool valid() const {
539  return pos == -1 ? false : true;
540  }
541 };
542 
544 
564 protected:
565  const QoreListNode* l;
566  qore_offset_t pos;
567 
568 public:
570 
573  DLLEXPORT ConstListIterator(const QoreListNode* lst, size_t n_pos = -1);
574 
576 
579  DLLEXPORT ConstListIterator(const QoreListNode& lst, size_t n_pos = -1);
580 
582 
587  DLLEXPORT bool next();
588 
590 
596  DLLEXPORT bool prev();
597 
599 
604  DLLEXPORT int set(size_t n_pos);
605 
607 
609  DLLEXPORT QoreValue getReferencedValue() const;
610 
612  DLLEXPORT const QoreValue getValue() const;
613 
615  DLLEXPORT bool first() const;
616 
618  DLLEXPORT bool last() const;
619 
621  DLLLOCAL size_t index() const { return pos; }
622 
624  DLLLOCAL size_t max() const { return l->size(); }
625 
627  DLLLOCAL const QoreListNode* getList() const { return l; }
628 
630  DLLLOCAL bool empty() const {
631  return l->empty();
632  }
633 
635  DLLLOCAL bool valid() const {
636  return pos == -1 ? false : true;
637  }
638 
640  DLLEXPORT void reset();
641 };
642 
643 #endif
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:57
For use on the stack only: iterates through elements of a const QoreListNode.
Definition: QoreListNode.h:563
DLLEXPORT bool prev()
moves the iterator to the previous element, returns true if the iterator is pointing to an element of...
DLLLOCAL bool valid() const
returns true if the iterator is pointing to a valid element
Definition: QoreListNode.h:635
DLLLOCAL const QoreListNode * getList() const
returns the list
Definition: QoreListNode.h:627
DLLLOCAL bool empty() const
returns true if the list is empty
Definition: QoreListNode.h:630
DLLEXPORT QoreValue getReferencedValue() const
returns the referenced value of the list element
DLLEXPORT bool next()
moves the iterator to the next element, returns true if the iterator is pointing to an element of the...
DLLEXPORT int set(size_t n_pos)
sets the iterator to a specific position in the list
DLLLOCAL size_t max() const
returns the number of elements in the list
Definition: QoreListNode.h:624
DLLEXPORT const QoreValue getValue() const
returns a pointer to the value of the list element
DLLEXPORT void reset()
resets the iterator to its initial state
DLLEXPORT bool first() const
returns true when the iterator is pointing to the first element in the list
DLLLOCAL size_t index() const
returns the current iterator position in the list or -1 if not pointing at a valid element
Definition: QoreListNode.h:621
DLLEXPORT bool last() const
returns true when the iterator is pointing to the last element in the list
DLLEXPORT ConstListIterator(const QoreListNode *lst, size_t n_pos=-1)
initializes the iterator to the position given or, if omitted, just before the first element
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48
For use on the stack only: iterates through a the elements of a QoreListNode.
Definition: QoreListNode.h:463
DLLLOCAL size_t max() const
returns the number of elements in the list
Definition: QoreListNode.h:527
DLLLOCAL bool empty() const
returns true if the list is empty
Definition: QoreListNode.h:533
DLLEXPORT QoreValue getValue() const
returns a pointer to the value of the list element
DLLEXPORT bool last() const
returns true when the iterator is pointing to the last element in the list
DLLEXPORT ListIterator(QoreListNode *lst, size_t n_pos=-1)
initializes the iterator to the position given or, if omitted, just before the first element
DLLEXPORT bool prev()
moves the iterator to the previous element, returns true if the iterator is pointing to an element of...
DLLEXPORT bool first() const
returns true when the iterator is pointing to the first element in the list
DLLEXPORT int set(size_t n_pos)
sets the iterator to a specific position in the list
DLLLOCAL bool valid() const
returns true if the iterator is pointing to a valid element
Definition: QoreListNode.h:538
DLLEXPORT bool next()
moves the iterator to the next element, returns true if the iterator is pointing to an element of the...
DLLEXPORT QoreValue getReferencedValue() const
returns the referenced value of the list element
DLLLOCAL QoreListNode * getList()
returns the list
Definition: QoreListNode.h:530
DLLLOCAL size_t index() const
returns the current iterator position in the list or -1 if not pointing at a valid element
Definition: QoreListNode.h:524
This is the list container type in Qore, dynamically allocated only, reference counted.
Definition: QoreListNode.h:52
virtual DLLEXPORT bool getAsBoolImpl() const
returns false unless perl-boolean-evaluation is enabled, in which case it returns false only when emp...
virtual DLLEXPORT AbstractQoreNode * realCopy() const
returns true if the list contains parse expressions and therefore needs evaluation to return a value,...
hashdecl qore_list_private * priv
this structure holds the private implementation for the type
Definition: QoreListNode.h:67
DLLLOCAL bool isVariableList() const
this function is not exported in the qore library
DLLEXPORT QoreValue shift()
returns the first element of the list, all other entries are moved down to fill up the first position...
virtual DLLEXPORT bool is_equal_soft(const AbstractQoreNode *v, ExceptionSink *xsink) const
tests for equality ("deep compare" including all contained values) with possible type conversion (sof...
DLLEXPORT QoreListNode * extract(qore_offset_t offset)
truncates the list at position "offset" (first element is offset 0) and returns any elements removed ...
DLLEXPORT QoreValue min(ExceptionSink *xsink) const
returns the element having the lowest value (determined by calling OP_LOG_LT - the less-than "<" oper...
DLLEXPORT size_t size() const
returns the number of elements in the list
DLLEXPORT int merge(const QoreListNode *list, ExceptionSink *xsink)
appends the elements of "list" to this list
virtual DLLEXPORT bool is_equal_hard(const AbstractQoreNode *v, ExceptionSink *xsink) const
tests for equality ("deep compare" including all contained values) without type conversions (hard com...
DLLEXPORT QoreListNode * evalList(ExceptionSink *xsink) const
evaluates the list and returns a value (or 0)
DLLEXPORT int push(QoreValue val, ExceptionSink *xsink)
adds a value to the list
DLLEXPORT QoreListNode * copyListFrom(size_t index) const
performs a deep copy of the list starting from element "offset" and returns the new list
DLLEXPORT QoreListNode * sort(ExceptionSink *xsink) const
returns a new list based on quicksorting the source list ("this")
virtual DLLEXPORT ~QoreListNode()
the destructor is protected so it cannot be called directly
DLLEXPORT const QoreTypeInfo * getValueTypeInfo() const
returns the value type declaration (if set)
DLLEXPORT const QoreTypeInfo * getTypeInfo() const
returns the type info structure for the current value; also works for lists with a specific value typ...
DLLEXPORT QoreListNode * listRefSelf() const
returns "this" with an incremented reference count
DLLEXPORT QoreListNode * splice(qore_offset_t offset)
truncates the list at position "offset" (first element is offset 0) and returns any elements removed ...
DLLEXPORT QoreValue getReferencedEntry(size_t index) const
returns the element at "index" (first element is index 0), the caller owns the reference
DLLEXPORT int getAsString(QoreString &str, int foff, ExceptionSink *xsink) const
concatenate the verbose string representation of the list (including all contained values) to an exis...
DLLEXPORT int setEntry(size_t index, QoreValue val, ExceptionSink *xsink)
sets the value of a list element
DLLLOCAL void setFinalized()
this function is not exported in the qore library
DLLEXPORT QoreListNode * copy() const
performs a deep copy of the list and returns the new list
static DLLLOCAL const char * getStaticTypeName()
returns true if the list does not contain any parse expressions, otherwise returns false
Definition: QoreListNode.h:148
virtual DLLEXPORT const char * getTypeName() const
returns the type name as a c string
DLLEXPORT QoreValue retrieveEntry(size_t index)
returns the element at "index" (first element is index 0)
virtual DLLEXPORT bool derefImpl(ExceptionSink *xsink)
dereferences all elements of the list
DLLEXPORT QoreListNode * sortDescending(ExceptionSink *xsink) const
returns a new list based on quicksorting the source list ("this") in descending order
DLLEXPORT int getEntryAsInt(size_t index) const
returns the value of element at "index" as an integer (first element is index 0)
DLLEXPORT QoreListNode * sortStable(ExceptionSink *xsink) const
returns a new list based on executing mergesort on the source list ("this")
DLLEXPORT QoreValue max(ExceptionSink *xsink) const
returns the element having the highest value (determined by calling OP_LOG_GT - the greater-than ">" ...
DLLEXPORT QoreListNode * reverse() const
returns a list with the order of the elements reversed
DLLEXPORT int insert(QoreValue val, ExceptionSink *xsink)
inserts a value in the first position of the list
DLLEXPORT QoreListNode * sortDescendingStable(ExceptionSink *xsink) const
returns a new list based on executing mergesort on the source list ("this") in descending order
virtual DLLLOCAL int parseInit(QoreValue &val, QoreParseContext &parse_context)
for initialization of lists in the parse tree at parse time (always returns "this")
virtual DLLLOCAL QoreValue evalImpl(bool &needs_deref, ExceptionSink *xsink) const
optionally evaluates the argument
DLLEXPORT QoreListNode()
create an empty list
DLLEXPORT bool empty() const
returns true if the list is empty
DLLEXPORT QoreValue pop()
returns the last element of the list, the length is decremented by one, caller owns the reference
DLLLOCAL bool isFinalized() const
this function is not exported in the qore library
DLLLOCAL void setVariableList()
this function is not exported in the qore library
Qore's string type supported by the QoreEncoding class.
Definition: QoreString.h:93
base class for resolved call references
Definition: CallReferenceNode.h:109
intptr_t qore_offset_t
used for offsets that could be negative
Definition: common.h:76
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:275