epics::pvData::PVStructure::Formatter Struct Reference

#include "pvData.h"

Public Types
enum	mode_t { Auto, Plain, ANSI }
enum	format_t { Raw, NT, JSON }

Public Member Functions
	Formatter (const PVStructure &top)
FORCE_INLINE Formatter &	show (const BitSet &set)
FORCE_INLINE Formatter &	highlight (const BitSet &set)
FORCE_INLINE Formatter &	mode (mode_t m)
FORCE_INLINE Formatter &	format (format_t f)

Friends
epicsShareFunc std::ostream &	operator<< (std::ostream &strm, const Formatter &format)
void	printRaw (std::ostream &strm, const PVStructure::Formatter &format, const PVStructure &cur)

Detailed Description

Definition at line 874 of file pvData.h.

Member Enumeration Documentation

enum epics::pvData::PVStructure::Formatter::format_t

Enumerator
Raw
NT
JSON

Definition at line 880 of file pvData.h.

                      {
            Raw,
            NT,
            JSON,
        };

enum epics::pvData::PVStructure::Formatter::mode_t

Enumerator
Auto
Plain
ANSI

Definition at line 875 of file pvData.h.

                    {
            Auto,
            Plain,
            ANSI,
        };

Constructor & Destructor Documentation

epics::pvData::PVStructure::Formatter::Formatter ( const PVStructure &  top )

inlineexplicit

Definition at line 892 of file pvData.h.

            :xtop(top)
            ,xshow(0)
            ,xhighlight(0)
            ,xmode(Auto)
            ,xfmt(NT)
        {}

Member Function Documentation

FORCE_INLINE Formatter& epics::pvData::PVStructure::Formatter::format ( format_t  f )

inline

Definition at line 907 of file pvData.h.

{ xfmt = f; return *this; }

FORCE_INLINE Formatter& epics::pvData::PVStructure::Formatter::highlight ( const BitSet &  set )

inline

Definition at line 903 of file pvData.h.

{ xhighlight = &set; return *this; }

FORCE_INLINE Formatter& epics::pvData::PVStructure::Formatter::mode ( mode_t  m )

inline

Definition at line 905 of file pvData.h.

{ xmode = m; return *this; }

FORCE_INLINE Formatter& epics::pvData::PVStructure::Formatter::show ( const BitSet &  set )

inline

Definition at line 901 of file pvData.h.

{ xshow = &set; return *this; }

Friends And Related Function Documentation

epicsShareFunc std::ostream& operator<< ( std::ostream &  strm, const Formatter &  format  )

friend

Definition at line 402 of file printer.cpp.

{
    if(format.xfmt==PVStructure::Formatter::JSON) {
        JSONPrintOptions opts;
        opts.multiLine = false;
        printJSON(strm, format.xtop, format.xshow ? *format.xshow : BitSet().set(0), opts);
        strm<<'\n';
        return strm;

    } else if(format.xfmt==PVStructure::Formatter::NT) {
        std::string id(format.xtop.getStructure()->getID()),
                    idprefix(id.substr(0, id.find_first_of('.')));

        // NTTable
        if(idprefix=="epics:nt/NTTable:1") {
            if(printTable(strm, format.xtop))
                return strm;
        } else {
            //NTScalar, NTScalarArray, NTEnum, or anything with '.value'

            PVField::const_shared_pointer value(format.xtop.getSubField("value"));
            if(value) {
                switch(value->getField()->getType()) {
                case scalar:
                    strm<<format::indent();
                    printTimeT(strm, format.xtop);
                    strm<<std::setprecision(6)<<*static_cast<const PVScalar*>(value.get())<<' ';
                    printAlarmT(strm, format.xtop);
                    strm<<'\n';
                    return strm;

                case scalarArray:
                    strm<<format::indent();
                    printTimeT(strm, format.xtop);
                    printAlarmT(strm, format.xtop);
                    strm<<std::setprecision(6)<<*static_cast<const PVScalarArray*>(value.get())<<'\n';
                    return strm;

                case structure:
                    if(printEnumT(strm, format.xtop, true)) {
                        strm<<'\n';
                        return strm;
                    }
                    break;
                default:
                    break;
                }
            }
        }
    }
    // fall through unhandled as Raw

    PVStructure::Formatter format2(format);

    if(format2.xmode==PVStructure::Formatter::Auto)
        format2.xmode = useEscapes(strm) ? PVStructure::Formatter::ANSI : PVStructure::Formatter::Plain;

    printRaw(strm, format2, format.xtop);

    return strm;
}

void printRaw ( std::ostream &  strm, const PVStructure::Formatter &  format, const PVStructure &  cur  )

friend

Definition at line 317 of file printer.cpp.

{
    typedef std::deque<std::pair<const PVField*, size_t> > todo_t;
    todo_t todo;
    BitSet show, highlight;

    const long orig_indent = format::indent_value(strm);

    {
        if(format.xshow)
            show = *format.xshow;
        else
            show.set(0);

        if(format.xhighlight)
            highlight = *format.xhighlight;

        expandBS(format.xtop, show, true);
        expandBS(format.xtop, highlight, false);
        highlight &= show; // can't highlight hidden fields (paranoia)
    }

    if(!show.get(0)) return; // nothing to do here...

    todo.push_front(std::make_pair(&format.xtop, orig_indent));

    while(!todo.empty()) {
        todo_t::value_type cur(todo.front());
        todo.pop_front();

        format::indent_value(strm) = cur.second;

        bool hl = highlight.get(cur.first->getFieldOffset()) && format.xmode==PVStructure::Formatter::ANSI;
        if(hl)
            strm<<"\x1b[1m"; // Bold

        switch(cur.first->getField()->getType()) {
        case structure: {
            const PVStructure* str = static_cast<const PVStructure*>(cur.first);

            const PVFieldPtrArray& flds = str->getPVFields();

            for(PVFieldPtrArray::const_reverse_iterator it(flds.rbegin()), end(flds.rend()); it!=end; ++it) {
                const PVField *fld = (*it).get();
                if(!show.get(fld->getFieldOffset())) continue;

                todo.push_front(std::make_pair(fld, cur.second+1));
            }

            std::string id(cur.first->getField()->getID());

            strm<<format::indent()<<id<<' '<<cur.first->getFieldName();
            if(id=="alarm_t") {
                strm.put(' ');
                printAlarmTx(strm, *str);
            } else if(id=="time_t") {
                strm.put(' ');
                printTimeTx(strm, *str);
            } else if(id=="enum_t") {
                strm.put(' ');
                printEnumT(strm, *str, false);
            }
            strm.put('\n');
        }
            break;
        case scalar:
        case scalarArray:
            strm<<format::indent()<<cur.first->getField()->getID()<<' '<<cur.first->getFieldName()
                <<' '<<*cur.first
                <<'\n';
            break;
        case structureArray:
        case union_:
        case unionArray:
            strm<<*cur.first;
            break;
        }

        if(hl)
            strm<<"\x1b[0m"; // reset
    }

    format::indent_value(strm) = orig_indent;
}

---

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

• modules/pvData/src/pv/pvData.h