move virtual GetPath() implementation out of line to work around an apparent Fedora...

[wxWidgets.git] / include / wx / strconv.h

diff --git a/include/wx/strconv.h b/include/wx/strconv.h
index a4a18e5e43425335111f41b62b43b32a6b3d4bf0..0061aa770c524c6a0a70689ba21d3d0686bd0eed 100644 (file)
--- a/include/wx/strconv.h
+++ b/include/wx/strconv.h
@@ -36,10 +36,6 @@ class WXDLLIMPEXP_FWD_BASE wxString;
 // the error value returned by wxMBConv methods
 #define wxCONV_FAILED ((size_t)-1)
 
 // the error value returned by wxMBConv methods
 #define wxCONV_FAILED ((size_t)-1)
 

-// the default value for some length parameters meaning that the string is
-// NUL-terminated
-#define wxNO_LEN ((size_t)-1)
-

 // ----------------------------------------------------------------------------
 // wxMBConv (abstract base class for conversions)
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxMBConv (abstract base class for conversions)
 // ----------------------------------------------------------------------------


@@ -95,15 +91,18 @@ public:
     // Convenience functions for converting strings which may contain embedded
     // NULs and don't have to be NUL-terminated.
     //
     // Convenience functions for converting strings which may contain embedded
     // NULs and don't have to be NUL-terminated.
     //

-    // inLen is the length of the buffer including trailing NUL if any: if the
-    // last 4 bytes of the buffer are all NULs, these functions are more
-    // efficient as they avoid copying the string, but otherwise a copy is made
-    // internally which could be quite bad for (very) long strings.
+    // inLen is the length of the buffer including trailing NUL if any or
+    // wxNO_LEN if the input is NUL-terminated.

     //
     // outLen receives, if not NULL, the length of the converted string or 0 if
     // the conversion failed (returning 0 and not -1 in this case makes it
     // difficult to distinguish between failed conversion and empty input but
     //
     // outLen receives, if not NULL, the length of the converted string or 0 if
     // the conversion failed (returning 0 and not -1 in this case makes it
     // difficult to distinguish between failed conversion and empty input but

-    // this is done for backwards compatibility)
+    // this is done for backwards compatibility). Notice that the rules for
+    // whether outLen accounts or not for the last NUL are the same as for
+    // To/FromWChar() above: if inLen is specified, outLen is exactly the
+    // number of characters converted, whether the last one of them was NUL or
+    // not. But if inLen == wxNO_LEN then outLen doesn't account for the last
+    // NUL even though it is present.

     const wxWCharBuffer
         cMB2WC(const char *in, size_t inLen, size_t *outLen) const;
     const wxCharBuffer
     const wxWCharBuffer
         cMB2WC(const char *in, size_t inLen, size_t *outLen) const;
     const wxCharBuffer


@@ -237,7 +236,7 @@ private:
     // the conversion object we forward to
     wxMBConv *m_conv;
 
     // the conversion object we forward to
     wxMBConv *m_conv;
 

-    DECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames)
+    wxDECLARE_NO_ASSIGN_CLASS(wxConvBrokenFileNames);

 };
 
 #endif // __UNIX__
 };
 
 #endif // __UNIX__


@@ -276,7 +275,7 @@ private:
     // the current decoder state: this is only used by ToWChar() if srcLen
     // parameter is not wxNO_LEN, when working on the entire NUL-terminated
     // strings we neither update nor use the state
     // the current decoder state: this is only used by ToWChar() if srcLen
     // parameter is not wxNO_LEN, when working on the entire NUL-terminated
     // strings we neither update nor use the state

-    class DecoderState : StateMode
+    class DecoderState : private StateMode

     {
     private:
         // current state: this one is private as we want to enforce the use of
     {
     private:
         // current state: this one is private as we want to enforce the use of


@@ -308,7 +307,7 @@ private:
 
     // encoder state is simpler as we always receive entire Unicode characters
     // on input
 
     // encoder state is simpler as we always receive entire Unicode characters
     // on input

-    class EncoderState : StateMode
+    class EncoderState : private StateMode

     {
     private:
         Mode mode;
     {
     private:
         Mode mode;


@@ -510,7 +509,7 @@ public:
 
     void Clear();
 
 
     void Clear();
 

-    // return true if the conversion could be initilized successfully
+    // return true if the conversion could be initialized successfully

     bool IsOk() const;
 
 private:
     bool IsOk() const;
 
 private:


@@ -524,13 +523,19 @@ private:
     wxMBConv *DoCreate() const;
 
     // set the name (may be only called when m_name == NULL), makes copy of
     wxMBConv *DoCreate() const;
 
     // set the name (may be only called when m_name == NULL), makes copy of

-    // charset string
+    // the charset string

     void SetName(const char *charset);
 
 
     void SetName(const char *charset);
 
 

+    // m_name may be NULL in which case m_encoding should be used
+    //

     // note that we can't use wxString here because of compilation
     // dependencies: we're included from wx/string.h
     char *m_name;
     // note that we can't use wxString here because of compilation
     // dependencies: we're included from wx/string.h
     char *m_name;

+
+    // may be wxFONTENCODING_SYSTEM in which case m_name is used
+    //
+    // if m_name is NULL, then we should use the default system encoding

     wxFontEncoding m_encoding;
 
     // use CreateConvIfNeeded() before accessing m_convReal!
     wxFontEncoding m_encoding;
 
     // use CreateConvIfNeeded() before accessing m_convReal!


@@ -622,7 +627,7 @@ extern WXDLLIMPEXP_DATA_BASE(wxMBConv *) wxConvUI;
     #define wxFNCONV(name) wxConvFileName->cWX2MB(name)
     #define wxFNSTRINGCAST wxMBSTRINGCAST
 #else
     #define wxFNCONV(name) wxConvFileName->cWX2MB(name)
     #define wxFNSTRINGCAST wxMBSTRINGCAST
 #else

-#if defined( __WXOSX__ ) && wxMBFILES
+#if defined( __WXOSX_OR_COCOA__ ) && wxMBFILES

     #define wxFNCONV(name) wxConvFileName->cWC2MB( wxConvLocal.cWX2WC(name) )
 #else
     #define wxFNCONV(name) name
     #define wxFNCONV(name) wxConvFileName->cWC2MB( wxConvLocal.cWX2WC(name) )
 #else
     #define wxFNCONV(name) name