- Renamed class AssocArray to HashMap to match our existing class Map (note also

  that many STL implementations have a class hash_map next to class map, too)
- Changed some static File class member vars to be normal static variables, in
  yet another attempt to reduce header dependencies (in this case on hashmap.h)

svn-id: r21473

6 files changed, 44 insertions, 58 deletions

diff --git a/common/file.cpp b/common/file.cpp
index c9917f698a..b1ef8f4bec 100644
--- a/common/file.cpp
+++ b/common/file.cpp
@@ -21,6 +21,7 @@
  */
 
 #include "common/file.h"
+#include "common/hashmap.h"
 #include "common/util.h"
 #include "backends/fs/fs.h"
 
@@ -30,8 +31,13 @@
 
 namespace Common {
 
-StringList File::_defaultDirectories;
-File::FilesMap File::_filesMap;
+typedef HashMap<String, String> FilesMap;
+
+// The following two objects could be turned into static members of class
+// File. However, then we would be forced to #include hashmap in file.h
+// which seems to be a high price just for a simple beautification...
+static StringList _defaultDirectories;
+static FilesMap _filesMap;
 
 
 static FILE *fopenNoCase(const char *filename, const char *directory, const char *mode) {
diff --git a/common/file.h b/common/file.h
index d113e7f531..939cd3cdc5 100644
--- a/common/file.h
+++ b/common/file.h
@@ -27,7 +27,6 @@
 #include "common/scummsys.h"
 #include "common/str.h"
 #include "common/stream.h"
-#include "common/assocarray.h"
 
 namespace Common {
 
@@ -45,11 +44,6 @@ protected:
 	/** The name of this file, for debugging. */
 	String _name;
 
-	typedef AssocArray<String, String> FilesMap;
-
-	static StringList _defaultDirectories;
-	static FilesMap _filesMap;
-
 public:
 	enum AccessMode {
 		kFileReadMode = 1,
diff --git a/common/assocarray.cpp b/common/hashmap.cpp
index c0031b6ecb..9051398999 100644
--- a/common/assocarray.cpp
+++ b/common/hashmap.cpp
@@ -20,7 +20,8 @@
  *
  */
 
-// Code is based on:
+// The hash map (associative array) implementation in this file is
+// based on code by Andrew Y. Ng, 1996:
 
 /* 
  * Copyright (c) 1998-2003 Massachusetts Institute of Technology. 
@@ -47,15 +48,7 @@
  * OTHER DEALINGS IN THE SOFTWARE. 
  */
 
-/*************************************************
-
-  assocarray.h - Associative arrays
-
-  Andrew Y. Ng, 1996
-
-**************************************************/
-
-#include "common/assocarray.h"
+#include "common/hashmap.h"
 
 namespace Common {
 
diff --git a/common/assocarray.h b/common/hashmap.h
index 8505f48c19..da222d1bfb 100644
--- a/common/assocarray.h
+++ b/common/hashmap.h
@@ -20,7 +20,8 @@
  *
  */
 
-// Code is based on:
+// The hash map (associative array) implementation in this file is
+// based on code by Andrew Y. Ng, 1996:
 
 /* 
  * Copyright (c) 1998-2003 Massachusetts Institute of Technology. 
@@ -47,36 +48,28 @@
  * OTHER DEALINGS IN THE SOFTWARE. 
  */
 
-/*************************************************
-
-  assocarray.h - Associative arrays
-
-  Andrew Y. Ng, 1996
-
-**************************************************/
-
 #include "common/stdafx.h"
 #include "common/str.h"
 #include "common/util.h"
 
-#ifndef COMMON_ASSOCARRAY_H
-#define COMMON_ASSOCARRAY_H
+#ifndef COMMON_HASHMAP_H
+#define COMMON_HASHMAP_H
 
 namespace Common {
 
 typedef Common::String String;
 
-// If aa is an AssocArray<Key,Val>, then space is allocated each
+// If aa is an HashMap<Key,Val>, then space is allocated each
 // time aa[key] is referenced, for a new key. To "see" the value
 // of aa[key] but without allocating new memory, use aa.queryVal(key)
 // instead.
 // 
-// An AssocArray<Key,Val> Maps type Key to type Val. For each 
-// Key, we need a int hashit(Key,int) that hashes Key and returns 
-// an integer from 0 to hashsize-1, and a int data_eq(Key,Key) 
-// that returns true if the 2 arguments it is passed are to
-// be considered equal. Also, we assume that "=" works
-// on Val's for assignment.
+// A HashMap<Key,Val> maps objects of type Key to objects of type Val.
+// For each used Key type, we need an "uint hashit(Key,uint)" function
+// that computes a hash for the given Key object and returns it as an
+// an integer from 0 to hashsize-1, and also a "bool data_eq(Key,Key) "
+// function that returns true if if its two arguments are to be considered
+// equal. Also, we assume that "=" works on Val objects for assignment.
 
 uint hashit(int x, uint hashsize);
 bool data_eq(int x, int y);
@@ -99,9 +92,9 @@ uint nextTableSize(uint x);
 //#define DEBUG_HASH_COLLISIONS
 
 template <class Key, class Val>
-class AssocArray {
+class HashMap {
 private:
-	// data structure used by AssocArray internally to keep
+	// data structure used by HashMap internally to keep
 	// track of what's mapped to what.
 	struct aa_ref_t {
 		Key key;
@@ -121,8 +114,8 @@ private:
 
 public:
 
-	AssocArray();
-	~AssocArray();
+	HashMap();
+	~HashMap();
 
 	bool contains(const Key &key) const;
 
@@ -153,10 +146,10 @@ public:
 };
 
 //-------------------------------------------------------
-// AssocArray functions
+// HashMap functions
 
 template <class Key, class Val>
-int AssocArray<Key, Val>::lookup(const Key &key) const {
+int HashMap<Key, Val>::lookup(const Key &key) const {
 	uint ctr = hashit(key, _arrsize);
 
 	while (_arr[ctr] != NULL && !data_eq(_arr[ctr]->key, key)) {
@@ -171,7 +164,7 @@ int AssocArray<Key, Val>::lookup(const Key &key) const {
 	
 #ifdef DEBUG_HASH_COLLISIONS
 	_lookups++;
-	fprintf(stderr, "collisions %d, lookups %d, ratio %f in AssocArray %p; size %d num elements %d\n",
+	fprintf(stderr, "collisions %d, lookups %d, ratio %f in HashMap %p; size %d num elements %d\n",
 		_collisions, _lookups, ((double) _collisions / (double)_lookups),
 		(const void *)this, _arrsize, _nele);
 #endif
@@ -180,13 +173,13 @@ int AssocArray<Key, Val>::lookup(const Key &key) const {
 }
 
 template <class Key, class Val>
-bool AssocArray<Key, Val>::contains(const Key &key) const {
+bool HashMap<Key, Val>::contains(const Key &key) const {
 	uint ctr = lookup(key);
 	return (_arr[ctr] != NULL);
 }
 
 template <class Key, class Val>
-Key *AssocArray<Key, Val>::new_all_keys(void) const {
+Key *HashMap<Key, Val>::new_all_keys(void) const {
 	Key *all_keys;
 	uint ctr, dex;
 
@@ -212,7 +205,7 @@ Key *AssocArray<Key, Val>::new_all_keys(void) const {
 }
 
 template <class Key, class Val>
-Val *AssocArray<Key, Val>::new_all_values(void) const {
+Val *HashMap<Key, Val>::new_all_values(void) const {
 	Val *all_values;
 	uint ctr, dex;
 
@@ -239,7 +232,7 @@ Val *AssocArray<Key, Val>::new_all_values(void) const {
 }
 
 template <class Key, class Val>
-AssocArray<Key, Val>::AssocArray() {
+HashMap<Key, Val>::HashMap() {
 	uint ctr;
 
 	_arrsize = nextTableSize(0);
@@ -257,7 +250,7 @@ AssocArray<Key, Val>::AssocArray() {
 }
 
 template <class Key, class Val>
-AssocArray<Key, Val>::~AssocArray() {
+HashMap<Key, Val>::~HashMap() {
 	uint ctr;
 
 	for (ctr = 0; ctr < _arrsize; ctr++)
@@ -268,7 +261,7 @@ AssocArray<Key, Val>::~AssocArray() {
 }
 
 template <class Key, class Val>
-void AssocArray<Key, Val>::clear(bool shrinkArray) {
+void HashMap<Key, Val>::clear(bool shrinkArray) {
 	for (uint ctr = 0; ctr < _arrsize; ctr++) {
 		if (_arr[ctr] != NULL) {
 			delete _arr[ctr];
@@ -290,7 +283,7 @@ void AssocArray<Key, Val>::clear(bool shrinkArray) {
 }
 
 template <class Key, class Val>
-void AssocArray<Key, Val>::expand_array(void) {
+void HashMap<Key, Val>::expand_array(void) {
 	aa_ref_t **old_arr;
 	uint old_arrsize, old_nele, ctr, dex;
 
@@ -334,7 +327,7 @@ void AssocArray<Key, Val>::expand_array(void) {
 }
 
 template <class Key, class Val>
-Val &AssocArray<Key, Val>::operator [](const Key &key) {
+Val &HashMap<Key, Val>::operator [](const Key &key) {
 	uint ctr = lookup(key);
 
 	if (_arr[ctr] == NULL) {
@@ -352,12 +345,12 @@ Val &AssocArray<Key, Val>::operator [](const Key &key) {
 }
 
 template <class Key, class Val>
-const Val &AssocArray<Key, Val>::operator [](const Key &key) const {
+const Val &HashMap<Key, Val>::operator [](const Key &key) const {
 	return queryVal(key);
 }
 
 template <class Key, class Val>
-const Val &AssocArray<Key, Val>::queryVal(const Key &key) const {
+const Val &HashMap<Key, Val>::queryVal(const Key &key) const {
 	uint ctr = lookup(key);
 	assert(_arr[ctr] != NULL);
 	return _arr[ctr]->dat;
diff --git a/common/module.mk b/common/module.mk
index 8630e3c7ab..dc8048db64 100644
--- a/common/module.mk
+++ b/common/module.mk
@@ -1,10 +1,10 @@
 MODULE := common
 
 MODULE_OBJS := \
-	assocarray.o \
 	config-file.o \
 	config-manager.o \
 	file.o \
+	hashmap.o \
 	md5.o \
 	mutex.o \
 	str.o \
diff --git a/gui/eval.h b/gui/eval.h
index 799a6f74e8..1b2df123d4 100644
--- a/gui/eval.h
+++ b/gui/eval.h
@@ -25,12 +25,12 @@
 
 #include "common/stdafx.h"
 #include "common/str.h"
-#include "common/assocarray.h"
+#include "common/hashmap.h"
 
 namespace GUI {
 
 using Common::String;
-using Common::AssocArray;
+using Common::HashMap;
 
 #define EVAL_UNDEF_VAR -13375
 
@@ -67,8 +67,8 @@ public:
 
 	void reset();
 
-	typedef AssocArray<String, int> VariablesMap;
-	typedef AssocArray<String, String> AliasesMap;
+	typedef HashMap<String, int> VariablesMap;
+	typedef HashMap<String, String> AliasesMap;
 
 private:
 	void getToken();