common.h

Go to the documentation of this file.
00001 
00002 
00003 
00004 
00005 
00006 
00007 /***********************************************************************
00008  Copyright (c) 1998 by Kevin Atkinson, (c) 1999, 2000 and 2001 by
00009  MySQL AB, and (c) 2004-2007 by Educational Technology Resources, Inc.
00010  Others may also hold copyrights on code in this file.  See the CREDITS
00011  file in the top directory of the distribution for details.
00012 
00013  This file is part of MySQL++.
00014 
00015  MySQL++ is free software; you can redistribute it and/or modify it
00016  under the terms of the GNU Lesser General Public License as published
00017  by the Free Software Foundation; either version 2.1 of the License, or
00018  (at your option) any later version.
00019 
00020  MySQL++ is distributed in the hope that it will be useful, but WITHOUT
00021  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00022  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00023  License for more details.
00024 
00025  You should have received a copy of the GNU Lesser General Public
00026  License along with MySQL++; if not, write to the Free Software
00027  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
00028  USA
00029 ***********************************************************************/
00030 
00031 #if !defined(MYSQLPP_COMMON_H)
00032 #define MYSQLPP_COMMON_H
00033 
00034 #if !defined(DOXYGEN_IGNORE)
00035 // Doxygen will not generate documentation for the following stuff.
00036 
00037 #include <mysql_version.h>
00038 
00039 // Work out major platform-specific stuff here.
00040 #if defined(__WIN32__) || defined(_WIN32)
00041 #       define MYSQLPP_PLATFORM_WINDOWS
00042 
00043         // Windows compiler support.  Tested with Microsoft Visual C++,
00044         // Borland C++ Builder, and MinGW GCC.
00045 #       include <winsock.h>
00046 
00047         // The shutdown_level argument was added in MySQL 4.1.3 and in 5.0.1.
00048 #       if ((MYSQL_VERSION_ID >= 40103) && (MYSQL_VERSION_ID <= 49999)) || (MYSQL_VERSION_ID >= 50001)
00049 #               define HAVE_MYSQL_SHUTDOWN_LEVEL_ARG
00050 #       endif
00051 
00052         // Stuff for Visual C++ only
00053 #       if defined(_MSC_VER)
00054                 // Disable whining about using 'this' as a member initializer on VC++.
00055 #               pragma warning(disable: 4355)
00056                 // Disable whining about implicit conversions to bool
00057 #               pragma warning(disable: 4800)
00058                 // Disable nagging about new "secure" functions like strncpy_s()
00059 #               pragma warning(disable: 4996)
00060                 // Call _snprintf() for VC++ version of snprintf() function
00061 #               define snprintf _snprintf
00062 #       endif
00063 
00064         // Define DLL import/export tags for Windows compilers, where we build
00065         // the library into a DLL, for LGPL license compatibility reasons.
00066         // (This is based on a similar mechanism in wxWindows.)
00067 
00068         #ifdef MYSQLPP_MAKING_DLL
00069                 // When making the DLL, export tagged symbols, so they appear
00070                 // in the import library.
00071                 #define MYSQLPP_EXPORT __declspec(dllexport)
00072         #elif !defined(MYSQLPP_NO_DLL)
00073                 // We must be _using_ the DLL, so import symbols instead.
00074                 #define MYSQLPP_EXPORT __declspec(dllimport)
00075         #else
00076                 // Not making a DLL at all, so no-op these declspecs
00077                 #define MYSQLPP_EXPORT
00078         #endif
00079 #else
00080         // If not Windows, we assume some sort of Unixy build environment,
00081         // where autotools is used.  (This includes Cygwin!)  #include the
00082         // config.h file only if this file was included from a non-header
00083         // file, because headers must not be dependent on config.h.
00084 #       if defined(MYSQLPP_NOT_HEADER)
00085 #               include "config.h"
00086 #       endif
00087 
00088         // Make DLL stuff a no-op on this platform.
00089         #define MYSQLPP_EXPORT
00090 #endif
00091 
00092 namespace mysqlpp {
00093 
00096 const bool use_exceptions = true;
00097 
00099 enum sql_cmp_type { sql_use_compare };
00100 
00101 #if !defined(DOXYGEN_IGNORE)
00102 // Figure out how to get large integer support on this system.  Suppress
00103 // refman documentation for these typedefs, as they're system-dependent.
00104 #if defined(NO_LONG_LONGS)
00105 // Alias "longlong" and "ulonglong" to the regular "long" counterparts
00106 typedef unsigned long ulonglong;
00107 typedef long longlong;
00108 #elif defined(_MSC_VER)
00109 // It's VC++, so we'll use Microsoft's 64-bit integer types
00110 typedef unsigned __int64 ulonglong;
00111 typedef __int64 longlong;
00112 #else
00113 // No better idea, so assume the C99 convention.  If your compiler
00114 // doesn't support this, please provide a patch to extend this ifdef, or
00115 // define NO_LONG_LONGS.
00116 typedef unsigned long long ulonglong;
00117 typedef long long longlong;
00118 #endif
00119 #endif // !defined(DOXYGEN_IGNORE)
00120 
00122 typedef const char cchar;
00123 
00124 #if !defined(MYSQLPP_NO_UNSIGNED_INT_TYPES)
00126 typedef unsigned int uint;
00128 typedef unsigned long ulong;
00129 #endif
00130 
00131 } // end namespace mysqlpp
00132 
00133 // The MySQL headers define these macros, which is completely wrong in a
00134 // C++ project.  Undo the damage.
00135 #undef min
00136 #undef max
00137 
00138 #endif // !defined(DOXYGEN_IGNORE)
00139 
00140 
00141 // Now that we've defined all the stuff above, we can pull in the full
00142 // MySQL header.  Basically, the above largely replaces MySQL's my_global.h
00143 // while actually working with C++.  This is why we disobey the MySQL
00144 // developer docs, which recommend using my_global.h.
00145 #include <mysql.h>
00146 
00147 
00148 namespace mysqlpp {
00149 
00151 typedef MYSQL_FIELD Field;
00152 
00153 } // end namespace mysqlpp
00154 
00155 #endif // !defined(MYSQLPP_COMMON_H)

Generated on Tue Jan 23 12:05:16 2007 for MySQL++ by  doxygen 1.5.1-3