1 /*!
2 * \file trc_printable_elem.h
3 * \brief OpenCSD : Standard printable element base class.
4 *
5 * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
6 */
7
8
9 /*
10 * Redistribution and use in source and binary forms, with or without modification,
11 * are permitted provided that the following conditions are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 *
20 * 3. Neither the name of the copyright holder nor the names of its contributors
21 * may be used to endorse or promote products derived from this software without
22 * specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
28 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
36 #ifndef ARM_TRC_PRINTABLE_ELEM_H_INCLUDED
37 #define ARM_TRC_PRINTABLE_ELEM_H_INCLUDED
38
39 #include <string>
40 #include <cstdint>
41
42 /** @addtogroup ocsd_infrastructure
43 @{*/
44
45 /*!
46 * @class trcPrintableElem
47 * @brief Class to provide trace element strings for printing
48 *
49 * Provide a standard interface to the trace packet classes to allow the packets
50 * to be printed in logging or tools.
51 *
52 * Provides some standard formatting functionality
53 *
54 */
55 class trcPrintableElem
56 {
57 public:
trcPrintableElem()58 trcPrintableElem() {};
~trcPrintableElem()59 virtual ~trcPrintableElem() {};
60 virtual void toString(std::string &str) const;
61 virtual void toStringFmt(const uint32_t fmtFlags, std::string &str) const;
62
63 // print formatting utilities
64 static void getValStr(std::string &valStr, const int valTotalBitSize, const int valValidBits, const uint64_t value, const bool asHex = true, const int updateBits = 0);
65
66 };
67
toString(std::string & str)68 inline void trcPrintableElem::toString(std::string &str) const
69 {
70 str = "Trace Element : print not implemented";
71 }
72
toStringFmt(const uint32_t,std::string & str)73 inline void trcPrintableElem::toStringFmt(const uint32_t /*fmtFlags*/, std::string &str) const
74 {
75 toString(str);
76 }
77
78 /** static template string function - used in "C" API to provide generic printing */
79 template<class Pc, class Pt>
trcPrintElemToString(const void * p_pkt,std::string & str)80 void trcPrintElemToString(const void *p_pkt, std::string &str)
81 {
82 Pc pktClass;
83 pktClass = static_cast<const Pt *>(p_pkt);
84 pktClass.toString(str);
85 }
86
87 /** @}*/
88
89 #endif // ARM_TRC_PRINTABLE_ELEM_H_INCLUDED
90
91 /* End of File trc_printable_elem.h */
92