--- parser3/src/include/pa_array.h	2001/02/20 18:45:51	1.14
+++ parser3/src/include/pa_array.h	2001/03/19 17:42:12	1.26
@@ -1,18 +1,11 @@
-/*
-  $Id: pa_array.h,v 1.14 2001/02/20 18:45:51 paf Exp $
-*/
+/** @file
+	Parser: array class decl.
 
-/*
+	Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
 
-	Array               Chunk0
-	======              ========
-	head--------------->[ptr]
-	append_here-------->[ptr]
-	link_row            ........
-			.			.
-			.			[ptr]
-			...........>[link to the next chunk]
+	Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
 
+	$Id: pa_array.h,v 1.26 2001/03/19 17:42:12 paf Exp $
 */
 
 #ifndef PA_ARRAY_H
@@ -24,29 +17,62 @@
 #include "pa_types.h"
 #include "pa_string.h"
 
+/**	
+	Pooled Array.
+
+	Internal structure: @verbatim	
+
+	Array               Chunk0
+	======              ========
+	head--------------->[ptr]
+	append_here-------->[ptr]
+	link_row            ........
+			.			.
+			.			[ptr]
+			...........>[link to the next chunk]
+
+	@endverbatim
+*/
+
 class Array : public Pooled {
 public:
 
-	typedef void Item;
+	typedef void Item; ///< Array item type
 
 	enum {
-		CR_INITIAL_ROWS_DEFAULT=10,
-		CR_GROW_PERCENT=60
+		CR_INITIAL_ROWS_DEFAULT=10, ///< default preallocated row count
+		CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded()
 	};
 
 public:
 
 	Array(Pool& apool, int initial_rows=CR_INITIAL_ROWS_DEFAULT);
 
-	int size() const { return fused_rows; }
-	Array& operator += (const Item *src);
-	Array& append_array(const Array& src);
-	const Item *raw_get(int index) const {
-		// considering these true:
-		//   index increments from 0 to size()-1
-		//   index>=0 && index<size()
-		//   index>=cache_chunk_base
+	/// size Array. how many items are in it
+	int size() const { 
+		// for get and quick_get
+		cache_chunk_base=0;
+		cache_chunk=head;
+		return fused_rows; 
+	}
+	/// append Item to array
+	Array& operator += (Item *src);
+
+	/// dirty hack to allow constant items storage. I long for Array<const Item*>
+	Array& operator += (const Item *src) { return *this+=const_cast<Item*>(src); }
+
+	/// append other Array portion to this one. starting from offset
+	Array& append_array(const Array& src, int offset=0);
 
+	/** 
+		quickly gets some item considering...
+
+		these true:
+			- index increments from 0 to size()-1
+			- index>=0 && index<size()
+			- index>=cache_chunk_base
+	*/
+	Item *quick_get(int index) const {
 		// next chunk will be with "index" row
 		if(!(index<cache_chunk_base+cache_chunk->count)) {
 			int count=cache_chunk->count;
@@ -57,10 +83,9 @@ public:
 		return cache_chunk->rows[index-cache_chunk_base].item;
 	}
 
-	const Item *get(int index) const;
-	const char *get_cstr(int index) const { 
-		return static_cast<const char *>(get(index)); 
-	}
+	Item *get(int index) const;
+	void put(int index, Item *item);
+	/// convinient way to get strings from Array. I long for Array<const String *>
 	const String *get_string(int index) const { 
 		return static_cast<const String *>(get(index)); 
 	}
@@ -71,7 +96,7 @@ private:
 		// the number of rows in chunk
 		int count;
 		union Row {
-			const Item *item;
+			Item *item;
 			Chunk *link;  // link to the next chunk in chain
 		} rows[1];
 		// next rows are here