inet::ObjectPrinter Class Reference

A utility class to serialize an object in text form. More...

#include <ObjectPrinter.h>

Public Member Functions
	ObjectPrinter (ObjectPrinterRecursionPredicate recursionPredicate, const std::vector< cMatchExpression * > &objectMatchExpressions, const std::vector< std::vector< cMatchExpression * >> &fieldNameMatchExpressionsList, int indentSize=4)
	Accepts the parsed form of the pattern string. More...
	ObjectPrinter (ObjectPrinterRecursionPredicate recursionPredicate=nullptr, const char *pattern="*", int indentSize=4)
	Pattern syntax is that of the "eventlog-message-detail-pattern" configuration entry – see documentation there. More...
	~ObjectPrinter ()
	Destructor. More...
void	printObjectToStream (std::ostream &ostream, cObject *object)
std::string	printObjectToString (cObject *object)

Protected Member Functions
void	printIndent (std::ostream &ostream, int level)
void	printObjectToStream (std::ostream &ostream, any_ptr object, cClassDescriptor *descriptor, any_ptr *objects, int level)
bool	matchesObjectField (cObject *object, int fieldIndex)

Protected Attributes
int	indentSize
char	buffer [1024]
std::vector< cMatchExpression * >	objectMatchExpressions
std::vector< std::vector< cMatchExpression * > >	fieldNameMatchExpressionsList
ObjectPrinterRecursionPredicate	recursionPredicate

Detailed Description

A utility class to serialize an object in text form.

Constructor & Destructor Documentation

ObjectPrinter() [1/2]

inet::ObjectPrinter::ObjectPrinter	(	ObjectPrinterRecursionPredicate	recursionPredicate,
		const std::vector< cMatchExpression * > &	objectMatchExpressions,
		const std::vector< std::vector< cMatchExpression * >> &	fieldNameMatchExpressionsList,
		int	indentSize = 4
	)

Accepts the parsed form of the pattern string.

The two vectors must be of the same size. The contained MatchExpression objects will be deallocated by this ObjectPrinter.

{
    ASSERT(objectMatchExpressions.size() == fieldNameMatchExpressionsList.size());
    this->recursionPredicate = recursionPredicate ? recursionPredicate : defaultRecurseIntoMessageFields;
    this->objectMatchExpressions = objectMatchExpressions;
    this->fieldNameMatchExpressionsList = fieldNameMatchExpressionsList;
    this->indentSize = indentSize;
}

ObjectPrinter() [2/2]

inet::ObjectPrinter::ObjectPrinter	(	ObjectPrinterRecursionPredicate	recursionPredicate = nullptr,
		const char *	pattern = "*",
		int	indentSize = 4
	)

Pattern syntax is that of the "eventlog-message-detail-pattern" configuration entry – see documentation there.

Recommended pattern for packet printing: "*: not className and not fullName and not fullPath and not info and not rawBin and not rawHex"

Just some examples here: "*": captures all fields of all messages "*Msg | *Packet": captures all fields of classes named AnythingMsg or AnythingPacket "*Frame:*Address,*Id": captures all fields named anythingAddress and anythingId from objects of any class named AnythingFrame "MyMessage:declaredOn(MyMessage)": captures instances of MyMessage recording the fields declared on the MyMessage class "*:(not declaredOn(cMessage) and not declaredOn(cNamedObject) and not declaredOn(cObject))": records user-defined fields from all objects

{
    std::vector<cMatchExpression *> objectMatchExpressions;
    std::vector<std::vector<cMatchExpression *>> fieldNameMatchExpressionsList;
 
    cStringTokenizer tokenizer(objectFieldMatcherPattern, "|;");
    std::vector<std::string> patterns = tokenizer.asVector();
 
    for (auto& pattern : patterns) {
        char *objectPattern = (char *)pattern.c_str();
        char *fieldNamePattern = strchr(objectPattern, ':');
 
        if (fieldNamePattern) {
            *fieldNamePattern = '\0';
            cStringTokenizer fieldNameTokenizer(fieldNamePattern + 1, ",");
            std::vector<std::string> fieldNamePatterns = fieldNameTokenizer.asVector();
            std::vector<cMatchExpression *> fieldNameMatchExpressions;
 
            for (auto& fieldNamePattern : fieldNamePatterns)
                fieldNameMatchExpressions.push_back(new cMatchExpression(fieldNamePattern.c_str(), false, true, true));
 
            fieldNameMatchExpressionsList.push_back(fieldNameMatchExpressions);
        }
        else {
            std::vector<cMatchExpression *> fieldNameMatchExpressions;
            fieldNameMatchExpressions.push_back(new cMatchExpression("*", false, true, true));
            fieldNameMatchExpressionsList.push_back(fieldNameMatchExpressions);
        }
 
        objectMatchExpressions.push_back(new cMatchExpression(objectPattern, false, true, true));
    }
 
    ASSERT(objectMatchExpressions.size() == fieldNameMatchExpressionsList.size());
    this->recursionPredicate = recursionPredicate ? recursionPredicate : defaultRecurseIntoMessageFields;
    this->objectMatchExpressions = objectMatchExpressions;
    this->fieldNameMatchExpressionsList = fieldNameMatchExpressionsList;
    this->indentSize = indentSize;
}

~ObjectPrinter()

inet::ObjectPrinter::~ObjectPrinter

(

)

Destructor.

{
    for (int i = 0; i < (int)objectMatchExpressions.size(); i++) {
        delete objectMatchExpressions[i];
        std::vector<cMatchExpression *>& fieldNameMatchExpressions = fieldNameMatchExpressionsList[i];
        for (auto& fieldNameMatchExpression : fieldNameMatchExpressions)
            delete fieldNameMatchExpression;
    }
}

Member Function Documentation

matchesObjectField()

bool inet::ObjectPrinter::matchesObjectField ( cObject *  object, int  fieldIndex  )

protected

{
    const MatchableObject matchableObject(MatchableObject::ATTRIBUTE_CLASSNAME, object);
 
    for (int i = 0; i < (int)objectMatchExpressions.size(); i++) {
        cMatchExpression *objectMatchExpression = objectMatchExpressions[i];
 
        if (objectMatchExpression->matches(&matchableObject)) {
            std::vector<cMatchExpression *>& fieldNameMatchExpressions = fieldNameMatchExpressionsList[i];
 
            for (auto fieldNameMatchExpression : fieldNameMatchExpressions) {
                const MatchableField matchableField(object, fieldIndex);
 
                if (fieldNameMatchExpression->matches(&matchableField))
                    return true;
            }
        }
    }
 
    return false;
}

Referenced by printObjectToStream().

printIndent()

void inet::ObjectPrinter::printIndent ( std::ostream &  ostream, int  level  )

protected

{
    int count = level * indentSize;
    for (int i = 0; i < count; i++)
        ostream << " ";
}

Referenced by printObjectToStream().

printObjectToStream() [1/2]

void inet::ObjectPrinter::printObjectToStream ( std::ostream &  ostream, any_ptr  object, cClassDescriptor *  descriptor, any_ptr *  objects, int  level  )

protected

{
    if (level == MAXIMUM_OBJECT_PRINTER_LEVEL) {
        printIndent(ostream, level);
        ostream << "<pruned>\n";
        return;
    }
    else {
        for (int i = 0; i < level; i++) {
            if (parents[i] == object) {
                printIndent(ostream, level);
                ostream << "<recursion>\n";
                return;
            }
        }
    }
    if (!descriptor) {
        printIndent(ostream, level);
        if (level == 0)
            ostream << "{...}\n";
        else
            ostream << "...\n";
    }
    else {
        parents[level] = object;
        for (int fieldIndex = 0; fieldIndex < descriptor->getFieldCount(); fieldIndex++) {
            bool isArray = descriptor->getFieldIsArray(fieldIndex);
            bool isPointer = descriptor->getFieldIsPointer(fieldIndex);
            bool isCompound = descriptor->getFieldIsCompound(fieldIndex);
            bool isCObject = descriptor->getFieldIsCObject(fieldIndex);
            const char *fieldType = descriptor->getFieldTypeString(fieldIndex);
            const char *fieldName = descriptor->getFieldName(fieldIndex);
 
            int size = isArray ? descriptor->getFieldArraySize(object, fieldIndex) : 1;
            for (int elementIndex = 0; elementIndex < size; elementIndex++) {
                any_ptr fieldValue = isCompound ? descriptor->getFieldStructValuePointer(object, fieldIndex, elementIndex) : any_ptr(nullptr);
 
                ObjectPrinterRecursionControl result = RECURSE;
                if (recursionPredicate)
                    result = recursionPredicate(object, descriptor, fieldIndex, fieldValue, parents, level);
                if (result == SKIP || (descriptor->extendsCObject() && !matchesObjectField(fromAnyPtr<cObject>(object), fieldIndex)))
                    continue;
 
                printIndent(ostream, level + 1);
                ostream << fieldType << " ";
 
                if (isPointer)
                    ostream << "*";
                ostream << fieldName;
 
                if (isArray)
                    ostream << "[" << elementIndex << "]";
                ostream << " = ";
 
                if (isCompound) {
                    if (fieldValue != nullptr) {
                        cClassDescriptor *fieldDescriptor = isCObject ? cClassDescriptor::getDescriptorFor(fromAnyPtr<cObject>(fieldValue)) :
                            cClassDescriptor::getDescriptorFor(descriptor->getFieldStructName(fieldIndex));
 
                        if (isCObject && result == FULL_NAME)
                            ostream << fromAnyPtr<cObject>(fieldValue)->getFullName() << "\n";
                        else if (isCObject && result == FULL_PATH)
                            ostream << fromAnyPtr<cObject>(fieldValue)->getFullPath() << "\n";
                        else if (fieldDescriptor) {
                            if (isCObject)
                                ostream << "class " << fromAnyPtr<cObject>(fieldValue)->getClassName() << " ";
                            else
                                ostream << "struct " << descriptor->getFieldStructName(fieldIndex) << " ";
 
                            ostream << "{\n";
                            printObjectToStream(ostream, fieldValue, fieldDescriptor, parents, level + 1);
                            printIndent(ostream, level + 1);
                            ostream << "}\n";
                        }
                        else {
                            std::string value = descriptor->getFieldValueAsString(object, fieldIndex, elementIndex);
                            ostream << QUOTE(value.c_str()) << "\n";
                        }
                    }
                    else
                        ostream << "nullptr\n";
                }
                else {
                    std::string value = descriptor->getFieldValueAsString(object, fieldIndex, elementIndex);
                    ostream << QUOTE(value.c_str()) << "\n";
                }
            }
        }
    }
}

printObjectToStream() [2/2]

void inet::ObjectPrinter::printObjectToStream	(	std::ostream &	ostream,
		cObject *	object
	)

{
    any_ptr parents[MAXIMUM_OBJECT_PRINTER_LEVEL];
    cClassDescriptor *descriptor = cClassDescriptor::getDescriptorFor(object);
    ostream << "class " << descriptor->getName() << " {\n";
    printObjectToStream(ostream, toAnyPtr(object), descriptor, parents, 0);
    ostream << "}\n";
}

Referenced by printObjectToStream(), and printObjectToString().

printObjectToString()

std::string inet::ObjectPrinter::printObjectToString

(

cObject *

object

)

{
    std::stringstream out;
    printObjectToStream(out, object);
    return out.str();
}

Member Data Documentation

buffer

char inet::ObjectPrinter::buffer[1024]

protected

fieldNameMatchExpressionsList

std::vector<std::vector<cMatchExpression *> > inet::ObjectPrinter::fieldNameMatchExpressionsList

protected

Referenced by matchesObjectField(), ObjectPrinter(), and ~ObjectPrinter().

indentSize

int inet::ObjectPrinter::indentSize

protected

Referenced by ObjectPrinter(), and printIndent().

objectMatchExpressions

std::vector<cMatchExpression *> inet::ObjectPrinter::objectMatchExpressions

protected

Referenced by matchesObjectField(), ObjectPrinter(), and ~ObjectPrinter().

recursionPredicate

ObjectPrinterRecursionPredicate inet::ObjectPrinter::recursionPredicate

protected

Referenced by ObjectPrinter(), and printObjectToStream().

---

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

• ObjectPrinter.h
• ObjectPrinter.cc