Changeset 3545 for trunk/kStuff/include

Timestamp:

Aug 25, 2007, 7:15:18 PM (18 years ago)

Author:

bird

Message:

Helpers and macros.

Location:

trunk/kStuff/include/k

Files:

• kDefs.h (modified) (1 diff)
• kHlpAlloc.h (added)
• kHlpString.h (added)
• kTypes.h (modified) (1 diff)

trunk/kStuff/include/k/kDefs.h

@@ -379 +379 @@
 #define K_BIT64(bit)            ( KU64_C(1) << (bit))
 
-/** @} */
-
-#endif
-
+
+/** @name Parameter validation macros
+ * @{ */
+
+/** Return/Crash validation of a string argument. */
+#define K_VALIDATE_STRING(str) \
+    do { \
+        if (!K_VALID_PTR(str)) \
+            return KERR_INVALID_POINTER; \
+        kHlpStrLen(str); \
+    } while (0)
+
+/** Return/Crash validation of an optional string argument. */
+#define K_VALIDATE_OPTIONAL_STRING(str) \
+    do { \
+        if (str) \
+            K_VALIDATE_STRING(str); \
+    } while (0)
+
+/** Return/Crash validation of an output buffer. */
+#define K_VALIDATE_BUFFER(buf, cb) \
+    do { \
+        if (!K_VALID_PTR(buf)) \
+            return KERR_INVALID_POINTER; \
+        if ((cb) != 0) \
+        { \
+            KU8             __b; \
+            KU8 volatile   *__pb = (KU8 volatile *)(buf); \
+            KSIZE           __cbPage1 = 0x1000 - ((KUPTR)(__pb) & 0xfff); /* ASSUMES page size! */ \
+            __b = *__pb; *__pb = 0xff; *__pb = __b; \
+            if ((cb) > __cbPage1) \
+            { \
+                KSIZE __cb = (cb) - __cbPage1; \
+                __pb -= __cbPage1; \
+                for (;;) \
+                { \
+                    __b = *__pb; *__pb = 0xff; *__pb = __b; \
+                    if (__cb < 0x1000) \
+                        break; \
+                    __pb += 0x1000; \
+                    __cb -= 0x1000; \
+                } \
+            } \
+        } \
+        else \
+            return KERR_INVALID_PARAMETER; \
+    } while (0)
+
+/** Return/Crash validation of an optional output buffer. */
+#define K_VALIDATE_OPTIONAL_BUFFER(buf, cb) \
+    do { \
+        if ((buf) && (cb) != 0) \
+            K_VALIDATE_BUFFER(buf, cb); \
+    } while (0)
+
+/** Return validation of an enum argument. */
+#define K_VALIDATE_ENUM(arg, enumname) \
+    do { \
+        if ((arg) <= enumname##_INVALID || (arg) >= enumname##_END) \
+            return KERR_INVALID_PARAMETER; \
+    } while (0)
+
+/** Return validation of a flags argument. */
+#define K_VALIDATE_FLAGS(arg, AllowedMask) \
+    do { \
+        if ((arg) & ~(AllowedMask)) \
+            return KERR_INVALID_PARAMETER; \
+    } while (0)
+
+/** @} */
+
+/** @} */
+
+#endif
+

trunk/kStuff/include/k/kTypes.h

@@ -326 +326 @@
 #define KFOFF_PRI               KI64_PRI
 
+
+/**
+ * Memory Protection.
+ */
+typedef enum KPROT
+{
+    /** The usual invalid 0. */
+    KPROT_INVALID = 0,
+    /** No access (page not present). */
+    KPROT_NOACCESS,
+    /** Read only. */
+    KPROT_READONLY,
+    /** Read & write. */
+    KPROT_READWRITE,
+    /** Read & copy on write. */
+    KPROT_WRITECOPY,
+    /** Execute only. */
+    KPROT_EXECUTE,
+    /** Execute & read. */
+    KPROT_EXECUTE_READ,
+    /** Execute, read & write. */
+    KPROT_EXECUTE_READWRITE,
+    /** Execute, read & copy on write. */
+    KPROT_EXECUTE_WRITECOPY,
+    /** The usual end value. (exclusive) */
+    KPROT_END,
+    /** Blow the type up to 32-bits. */
+    KPROT_32BIT_HACK = 0x7fffffff
+} KPROT;
+/** Pointer to a memory protection enum. */
+typedef KPROT                  *PKPROT;
+/** Pointer to a const memory protection enum. */
+typedef KPROT const            *PCKPROT;
+
+/** Boolean.
+ * This can be used as a tri-state type, but then you *must* do == checks. */
+typedef KI8                     KBOOL;
+/** Pointer to a boolean value. */
+typedef KBOOL                  *PKBOOL;
+/** Pointer to a const boolean value. */
+typedef KBOOL const            *PCKBOOL;
+/** Maxium value the KBOOL type can hold (officially). */
+#define KBOOL_MIN               KI8_C(-1)
+/** Maxium value the KBOOL type can hold (officially). */
+#define KBOOL_MAX               KI8_C(1)
+/** The KBOOL printf format. */
+#define KBOOL_PRI               KU8_PRI
+/** Boolean true constant. */
+#define K_TRUE                  KI8_C(1)
+/** Boolean false constant. */
+#define K_FALSE                 KI8_C(0)
+/** Boolean unknown constant (the third state). */
+#define K_UNKNOWN               KI8_C(-1)
+
+
 /** @} */