source: trunk/synergy/lib/arch/IArchString.h@ 3830

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2002 Chris Schoeneman
 * 
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file COPYING that should have accompanied this file.
 * 
 * This package is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#ifndef IARCHSTRING_H
#define IARCHSTRING_H

#include "IInterface.h"
#include "BasicTypes.h"
#include <stdarg.h>

//! Interface for architecture dependent string operations
/*!
This interface defines the string operations required by
synergy.  Each architecture must implement this interface.
*/
class IArchString : public IInterface {
public:
        //! Wide character encodings
        /*!
        The known wide character encodings
        */
        enum EWideCharEncoding {
                kUCS2,          //!< The UCS-2 encoding
                kUCS4,          //!< The UCS-4 encoding
                kUTF16,         //!< The UTF-16 encoding
                kUTF32          //!< The UTF-32 encoding
        };

        //! @name manipulators
        //@{

        //! printf() to limited size buffer with va_list
        /*!
        This method is equivalent to vsprintf() except it will not write
        more than \c n bytes to the buffer, returning -1 if the output
    was truncated and the number of bytes written not including the
    trailing NUL otherwise.
        */
        virtual int                     vsnprintf(char* str,
                                                        int size, const char* fmt, va_list ap) = 0;

        //! Convert multibyte string to wide character string
        virtual int                     convStringMBToWC(wchar_t*,
                                                        const char*, UInt32 n, bool* errors) = 0;

        //! Convert wide character string to multibyte string
        virtual int                     convStringWCToMB(char*,
                                                        const wchar_t*, UInt32 n, bool* errors) = 0;

        //! Return the architecture's native wide character encoding
        virtual EWideCharEncoding
                                                getWideCharEncoding() = 0;

        //@}
};

#endif