correcting header path

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

diff --git a/include/wx/strconv.h b/include/wx/strconv.h
index 1aa5f97550b5971d46cb004aaaf4a5bd8cd95437..e9d68a51a3f30e96e943a50f460b9060513f67ce 100644 (file)
--- a/include/wx/strconv.h
+++ b/include/wx/strconv.h
@@ -95,15 +95,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


@@ -500,8 +503,6 @@ public:
                            const char *src, size_t srcLen = wxNO_LEN) const;
     virtual size_t FromWChar(char *dst, size_t dstLen,
                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;
                            const char *src, size_t srcLen = wxNO_LEN) const;
     virtual size_t FromWChar(char *dst, size_t dstLen,
                              const wchar_t *src, size_t srcLen = wxNO_LEN) const;

-    virtual size_t MB2WC(wchar_t *outputBuf, const char *psz, size_t outputSize) const;
-    virtual size_t WC2MB(char *outputBuf, const wchar_t *psz, size_t outputSize) const;

     virtual size_t GetMBNulLen() const;
 
 #if wxUSE_UNICODE_UTF8
     virtual size_t GetMBNulLen() const;
 
 #if wxUSE_UNICODE_UTF8


@@ -512,7 +513,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:


@@ -526,13 +527,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!