epics::pvData::escape Struct Reference

#include "typeCast.h"

Public Types
enum	style_t { C, CSV }

Public Member Functions
	escape (const std::string &orig)
	~escape ()
escape &	style (style_t s)
	Change escaping style. More...
std::string	str () const
	print to string and return. (alloc and copy) More...

Friends
epicsShareFunc std::ostream &	operator<< (std::ostream &strm, const escape &Q)

Detailed Description

Helper to print a string with escaping

strm<<'"'<<escape(astring)<<'"' 

Definition at line 218 of file typeCast.h.

Member Enumeration Documentation

enum epics::pvData::escape::style_t

Enumerator
C
CSV

Definition at line 220 of file typeCast.h.

                 {
        C,   // default
        CSV, // a la RFC4180
    };

Constructor & Destructor Documentation

epics::pvData::escape::escape ( const std::string &  orig )

inline

Definition at line 228 of file typeCast.h.

:orig(orig), S(C) {}

epics::pvData::escape::~escape

(

)

Definition at line 472 of file printer.cpp.

{}

Member Function Documentation

std::string epics::pvData::escape::str

(

)

const

print to string and return. (alloc and copy)

Definition at line 474 of file printer.cpp.

{
    std::ostringstream strm;
    strm<<(*this);
    return strm.str();
}

escape& epics::pvData::escape::style ( style_t  s )

inline

Change escaping style.

Definition at line 231 of file typeCast.h.

{ S = s; return *this; }

Friends And Related Function Documentation

epicsShareFunc std::ostream& operator<< ( std::ostream &  strm, const escape &  Q  )

friend

Definition at line 482 of file printer.cpp.

{
    for(size_t pos = 0, len = Q.orig.size(); pos < len; pos++) {
        const char C = Q.orig[pos];
        char quote = '\\', next;
        // compare me with epicsStrnEscapedFromRaw()
        switch(C) {
        case '\a': next = 'a'; break;
        case '\b': next = 'b'; break;
        case '\f': next = 'f'; break;
        case '\n': next = 'n'; break;
        case '\r': next = 'r'; break;
        case '\t': next = 't'; break;
        case '\v': next = 'v'; break;
        case '\\': next = '\\'; break;
        case '\'': next = '\''; break;
        case '\"': next = '\"'; if(Q.S==escape::CSV) quote = '"'; break;
        default:
            if(!isprint(C)) {
                // print three charator escape
                strm<<"\\x"<<hexdigit(C>>4)<<hexdigit(C);
            } else {
                // literal
                strm.put(C);
            }
            continue;
        }
        // print two charactor escape
        strm.put(quote);
        strm.put(next);
    }

    return strm;
}

---

The documentation for this struct was generated from the following files:

• modules/pvData/src/misc/pv/typeCast.h
• modules/pvData/src/factory/printer.cpp