Changeset 3555 for trunk/kStuff/include/k/kAVLTmpl/kAVLEnum.h

Timestamp:

Aug 26, 2007, 12:43:27 PM (18 years ago)

Author:

bird

Message:

Merging in kAvl enhancements, doing some config simplications and made them inlineable.

File:

• trunk/kStuff/include/k/kAVLTmpl/kAVLEnum.h (modified) (9 diffs)

trunk/kStuff/include/k/kAVLTmpl/kAVLEnum.h

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- *
- * kAVLEnum - Enumeration routine for AVL trees.
- *
- * Copyright (c) 1999-2002 knut st. osmundsen (bird@anduin.net)
- *
- * GPL
+ * kAVLTmpl - Templated AVL Trees, Node Enumeration.
  */
 
-#ifndef _kAVLEnum_h_
-#define _kAVLEnum_h_
-
-
-/**
- * Starts an enumeration of all nodes in the given AVL tree.
- * @returns   Pointer to the first node in the tree.
- * @param     ppTree     Pointer to the AVL-tree root node pointer.
- * @param     pEnumData  Pointer to enumeration control data.
- * @param     fFromLeft  TRUE:  Left to right.
- *                       FALSE: Right to left.
- * @status    completely implemented.
- * @author    knut st. osmundsen
+/*
+ * Copyright (c) 1999-2007 knut st. osmundsen <bird-src-spam@anduin.net>
+ *
+ * This file is part of kStuff.
+ *
+ * kStuff is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * kStuff is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with kStuff; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
  */
-PKAVLNODECORE KLIBCALL KAVL_FN(BeginEnumTree)(PPKAVLNODECORE ppTree, PKAVLENUMDATA pEnumData, int fFromLeft)
-{
-    KLOGENTRY3("PKAVLNODECORE","PPKAVLNODECORE ppTree, PKAVLENUMDATA pEnumData, int fFromLeft", ppTree, pEnumData, fFromLeft);
-    PKAVLNODECORE    pNode;
-    if (*ppTree != NULL)
-    {
-        pEnumData->fFromLeft = (char)fFromLeft;
-        pEnumData->cEntries = 1;
-        pEnumData->aEntries[0] = *ppTree;
-        pEnumData->achFlags[0] = 0;
-    }
-    else
-        pEnumData->cEntries = 0;
-
-    pNode = KAVL_FN(GetNextNode)(pEnumData);
-    KLOGEXIT(pNode);
-    return pNode;
-}
-
 
 /**
@@ -50 +32 @@
  * @author    knut st. osmundsen
  */
-PKAVLNODECORE KLIBCALL KAVL_FN(GetNextNode)(PKAVLENUMDATA pEnumData)
+KAVL_DECL(KAVLNODECORE *) KAVL_FN(GetNextNode)(KAVL_TYPE(,ENUMDATA) *pEnumData)
 {
-    KLOGENTRY1("PKAVLNODECORE","PKAVLENUMDATA pEnumData", pEnumData);
-    PKAVLNODECORE    pNode;
-
     if (pEnumData->fFromLeft)
     {   /* from left */
         while (pEnumData->cEntries > 0)
         {
-            pNode = pEnumData->aEntries[pEnumData->cEntries - 1];
+            KAVLNODECORE *pNode = pEnumData->aEntries[pEnumData->cEntries - 1];
 
             /* left */
@@ -65 +44 @@
             {
                 pEnumData->achFlags[pEnumData->cEntries - 1]++;
-                if (pNode->pLeft != NULL)
+                if (pNode->pLeft != KAVL_NULL)
                 {
                     pEnumData->achFlags[pEnumData->cEntries] = 0; /* 0 left, 1 center, 2 right */
-                    pEnumData->aEntries[pEnumData->cEntries++] = pNode->pLeft;
+                    pEnumData->aEntries[pEnumData->cEntries++] = KAVL_GET_POINTER(&pNode->pLeft);
                     continue;
                 }
@@ -77 +56 @@
             {
                 pEnumData->achFlags[pEnumData->cEntries - 1]++;
-                KLOGEXIT(pNode);
                 return pNode;
             }
@@ -83 +61 @@
             /* right */
             pEnumData->cEntries--;
-            if (pNode->pRight != NULL)
+            if (pNode->pRight != KAVL_NULL)
             {
                 pEnumData->achFlags[pEnumData->cEntries] = 0;
-                pEnumData->aEntries[pEnumData->cEntries++] = pNode->pRight;
+                pEnumData->aEntries[pEnumData->cEntries++] = KAVL_GET_POINTER(&pNode->pRight);
             }
         } /* while */
@@ -94 +72 @@
         while (pEnumData->cEntries > 0)
         {
-            pNode = pEnumData->aEntries[pEnumData->cEntries - 1];
-
+            KAVLNODECORE *pNode = pEnumData->aEntries[pEnumData->cEntries - 1];
 
             /* right */
@@ -101 +78 @@
             {
                 pEnumData->achFlags[pEnumData->cEntries - 1]++;
-                if (pNode->pRight != NULL)
+                if (pNode->pRight != KAVL_NULL)
                 {
                     pEnumData->achFlags[pEnumData->cEntries] = 0;  /* 0 right, 1 center, 2 left */
-                    pEnumData->aEntries[pEnumData->cEntries++] = pNode->pRight;
+                    pEnumData->aEntries[pEnumData->cEntries++] = KAVL_GET_POINTER(&pNode->pRight);
                     continue;
                 }
@@ -113 +90 @@
             {
                 pEnumData->achFlags[pEnumData->cEntries - 1]++;
-                KLOGEXIT(pNode);
                 return pNode;
             }
@@ -119 +95 @@
             /* left */
             pEnumData->cEntries--;
-            if (pNode->pLeft != NULL)
+            if (pNode->pLeft != KAVL_NULL)
             {
                 pEnumData->achFlags[pEnumData->cEntries] = 0;
-                pEnumData->aEntries[pEnumData->cEntries++] = pNode->pLeft;
+                pEnumData->aEntries[pEnumData->cEntries++] = KAVL_GET_POINTER(&pNode->pLeft);
             }
         } /* while */
     }
 
-    KLOGEXIT(NULL);
     return NULL;
 }
 
 
-#endif
+/**
+ * Starts an enumeration of all nodes in the given AVL tree.
+ *
+ * @returns Pointer to the first node in the enumeration.
+ * @param   ppTree      Pointer to the AVL-tree root node pointer.
+ * @param   pEnumData   Pointer to enumeration control data.
+ * @param   fFromLeft   K_TRUE:  Left to right.
+ *                      K_FALSE: Right to left.
+ */
+KAVL_DECL(KAVLNODECORE *) KAVL_FN(BeginEnumTree)(KAVLTREEPTR *ppTree, KAVL_TYPE(,ENUMDATA) *pEnumData, KBOOL fFromLeft)
+{
+    if (*ppTree != KAVL_NULL)
+    {
+        pEnumData->fFromLeft = fFromLeft;
+        pEnumData->cEntries = 1;
+        pEnumData->aEntries[0] = KAVL_GET_POINTER(ppTree);
+        pEnumData->achFlags[0] = 0;
+    }
+    else
+        pEnumData->cEntries = 0;
 
+    return KAVL_FN(GetNextNode)(pEnumData);
+}
+