stringf.h

Go to the documentation of this file.

/*
This program is distributed under the terms of the 'MIT license'. The text
of this licence follows...

Copyright (c) 2007 J.D.Medhurst (a.k.a. Tixy)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

#ifndef STRINGF_H
#define STRINGF_H

#include <stdarg.h> // for va_list

class StringFormatter
    {
public:
    size_t VFormat(const char* formatString, va_list args);

    size_t Format(const char* formatString, ...);

    size_t HexDumpLine(const void* data, size_t size, ptrdiff_t addressOffset=0);

protected:
    virtual void Out(const char* text, size_t textSize) =0;

    virtual void Out(char character, size_t repeatCount) =0;

protected:
    enum Flags
        {
        FlagMinus           = 1<<0,     
        FlagPlus            = 1<<1,     
        FlagSpace           = 1<<2,     
        FlagHash            = 1<<3,     
        FlagZero            = 1<<4,     

        LengthMod_hh        = 1<<8,     
        LengthMod_h         = 1<<9,     
        LengthMod_l         = 1<<10,    
        LengthMod_ll        = 1<<11,    
        LengthMod_L         = 1<<12,    
        LengthMod_unknown   = 1<<13,    

        SignedInt           = 1<<15     
        };

    class ConversionSpec
        {
    public:
        inline ConversionSpec(va_list args)
            : Args(args)
            {}

        const char* Decode(const char* format);

        longlong GetIntArg(unsigned flags);

        inline int GetIntArg()
            {
            return va_arg(Args,int);
            }

        inline void* GetPointerArg()
            {
            return va_arg(Args,void*);
            }

    private:
        const char* ReadInt(const char* format, int& val);

    public:
        va_list     Args;                   
        uint16_t    Flags;                  
        char        ConversionSpecifier;    
        int         FieldWidth;             
        int         Precision;              
        };

    virtual char* UnkownFormat(char*& dstEnd, ConversionSpec& spec);

    char* DefaultUnkownFormat(char*& dstEnd, ConversionSpec& spec);

public:
    static char* PushHex(ulonglong val, char* dst, int precision=-1, int x='x', int prefix=false);

    static char* PushOctal(ulonglong val, char* dst, int precision=-1, int prefix=false);

    static char* PushDecimal(ulonglong val, char* dst, int precision=-1);

#if !defined(_MSC_VER)

    static const size_t FormatTextBufferSize = 130;

    static const size_t HexDumpLineSize =
        sizeof(void*)*2     // digits in address
        +3*16               // 16 hex bytes with leading space
        +16/sizeof(void*)   // extra leading spaces used to group bytes
        +2                  // two spaces
        +16                 // 16 ascii characters
        +1+1;               // '\n' + NUL

#else
    // old versions of MSVC don't like static const members, so use enums...
    enum { FormatTextBufferSize = 130 };
    enum { HexDumpLineSize = sizeof(void*)*2+3*16+16/sizeof(void*)+2+16+1+1 };

#endif

    friend class StringFormatter::ConversionSpec;
    };


class StringBufferFormatter : public StringFormatter
    {
public:
    StringBufferFormatter(char* buffer, size_t size);

    // Implement output methods for StringFormatter...
    virtual void Out(const char* text, size_t textSize);
    virtual void Out(char character, size_t repeatCount);

    char* End();

protected:
    char* BufferStart;  
    char* BufferEnd;    
    char* BufferPtr;    
    };


extern "C" int vsprintf(char* str, const char* format, va_list ap);

extern "C" int sprintf(char* str, const char* format, ...);

extern "C" int vsnprintf(char* str, size_t size, const char* format, va_list ap);

extern "C" int snprintf(char* str, size_t size, const char* format, ...);

 // End of group

#endif // STRINGF_H