r842 - trunk

[DONOTREPLY at icculus.org]

Author: icculus
Date: 2007-03-16 18:06:04 -0400 (Fri, 16 Mar 2007)
New Revision: 842

Modified:
   trunk/CHANGELOG.txt
   trunk/physfs.h
Log:
Changed PHYSFS_file from a typedef to a #define for legacy code.


Modified: trunk/CHANGELOG.txt
===================================================================
--- trunk/CHANGELOG.txt	2007-03-15 08:19:17 UTC (rev 841)
+++ trunk/CHANGELOG.txt	2007-03-16 22:06:04 UTC (rev 842)
@@ -2,6 +2,9 @@
  * CHANGELOG.
  */
 
+03162007 - Changed PHYSFS_file from a typedef to a #define (in case it would
+           cause an aggressive compiler to think you're passing the wrong type
+           to a function) and added Doxygen comments to explain it.
 03152007 - Bunch of work on Unicode...added case-folding stricmp, removed
            platform-specific stricmp implementations, changed appropriate
            calls to an ASCII-only stricmp that ignores locale. Fixed case on

Modified: trunk/physfs.h
===================================================================
--- trunk/physfs.h	2007-03-15 08:19:17 UTC (rev 841)
+++ trunk/physfs.h	2007-03-16 22:06:04 UTC (rev 842)
@@ -339,9 +339,21 @@
     void *opaque;  /**< That's all you get. Don't touch. */
 } PHYSFS_File;
 
-typedef PHYSFS_File PHYSFS_file;  /* for backwards compatibility with 1.0 */
 
+/**
+ * \def PHYSFS_file
+ * \brief 1.0 API compatibility define.
+ *
+ * PHYSFS_file is identical to PHYSFS_File. This #define is here for backwards
+ *  compatibility with the 1.0 API, which had an inconsistent capitalization
+ *  convention in this case. New code should use PHYSFS_File, as this #define
+ *  may go away someday.
+ *
+ * \sa PHYSFS_File
+ */
+#define PHYSFS_file PHYSFS_File
 
+
 /**
  * \struct PHYSFS_ArchiveInfo
  * \brief Information on various PhysicsFS-supported archives.