xref: /freebsd-src/contrib/opencsd/decoder/include/pkt_printers/item_printer.h (revision c120c5646da1a1d2c4d90fd069a7e2a8d559eb46)
1*c120c564SAndrew Turner /*
2*c120c564SAndrew Turner  * \file       item_printer.h
3*c120c564SAndrew Turner  * \brief      OpenCSD :
4*c120c564SAndrew Turner  *
5*c120c564SAndrew Turner  * \copyright  Copyright (c) 2015, ARM Limited. All Rights Reserved.
6*c120c564SAndrew Turner  */
7*c120c564SAndrew Turner 
8*c120c564SAndrew Turner /*
9*c120c564SAndrew Turner  * Redistribution and use in source and binary forms, with or without modification,
10*c120c564SAndrew Turner  * are permitted provided that the following conditions are met:
11*c120c564SAndrew Turner  *
12*c120c564SAndrew Turner  * 1. Redistributions of source code must retain the above copyright notice,
13*c120c564SAndrew Turner  * this list of conditions and the following disclaimer.
14*c120c564SAndrew Turner  *
15*c120c564SAndrew Turner  * 2. Redistributions in binary form must reproduce the above copyright notice,
16*c120c564SAndrew Turner  * this list of conditions and the following disclaimer in the documentation
17*c120c564SAndrew Turner  * and/or other materials provided with the distribution.
18*c120c564SAndrew Turner  *
19*c120c564SAndrew Turner  * 3. Neither the name of the copyright holder nor the names of its contributors
20*c120c564SAndrew Turner  * may be used to endorse or promote products derived from this software without
21*c120c564SAndrew Turner  * specific prior written permission.
22*c120c564SAndrew Turner  *
23*c120c564SAndrew Turner  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
24*c120c564SAndrew Turner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25*c120c564SAndrew Turner  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26*c120c564SAndrew Turner  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27*c120c564SAndrew Turner  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28*c120c564SAndrew Turner  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29*c120c564SAndrew Turner  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30*c120c564SAndrew Turner  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31*c120c564SAndrew Turner  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32*c120c564SAndrew Turner  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33*c120c564SAndrew Turner  */
34*c120c564SAndrew Turner 
35*c120c564SAndrew Turner #ifndef ARM_ITEM_PRINTER_H_INCLUDED
36*c120c564SAndrew Turner #define ARM_ITEM_PRINTER_H_INCLUDED
37*c120c564SAndrew Turner 
38*c120c564SAndrew Turner #include "opencsd.h"
39*c120c564SAndrew Turner #include <string>
40*c120c564SAndrew Turner 
41*c120c564SAndrew Turner class ItemPrinter
42*c120c564SAndrew Turner {
43*c120c564SAndrew Turner public:
44*c120c564SAndrew Turner     ItemPrinter();
45*c120c564SAndrew Turner     virtual ~ItemPrinter();
46*c120c564SAndrew Turner 
setMessageLogger(ocsdMsgLogger * pMsgLogger)47*c120c564SAndrew Turner     void setMessageLogger(ocsdMsgLogger *pMsgLogger) { m_pMsgLogger = pMsgLogger; };
48*c120c564SAndrew Turner     void itemPrintLine(const std::string &msg);
49*c120c564SAndrew Turner 
50*c120c564SAndrew Turner     // return wait for the first N packets - test the wait mechanism.
51*c120c564SAndrew Turner     void setTestWaits(const int num_waits);
52*c120c564SAndrew Turner     const int getTestWaits() const;
53*c120c564SAndrew Turner     void decTestWaits();
54*c120c564SAndrew Turner 
55*c120c564SAndrew Turner protected:
56*c120c564SAndrew Turner     ocsdMsgLogger *m_pMsgLogger;
57*c120c564SAndrew Turner     int m_test_waits;
58*c120c564SAndrew Turner };
59*c120c564SAndrew Turner 
ItemPrinter()60*c120c564SAndrew Turner inline ItemPrinter::ItemPrinter() :
61*c120c564SAndrew Turner    m_pMsgLogger(0),
62*c120c564SAndrew Turner    m_test_waits(0)
63*c120c564SAndrew Turner {
64*c120c564SAndrew Turner }
65*c120c564SAndrew Turner 
~ItemPrinter()66*c120c564SAndrew Turner inline ItemPrinter::~ItemPrinter()
67*c120c564SAndrew Turner {
68*c120c564SAndrew Turner     m_pMsgLogger = 0;
69*c120c564SAndrew Turner }
70*c120c564SAndrew Turner 
itemPrintLine(const std::string & msg)71*c120c564SAndrew Turner inline void ItemPrinter::itemPrintLine(const std::string &msg)
72*c120c564SAndrew Turner {
73*c120c564SAndrew Turner     if(m_pMsgLogger)
74*c120c564SAndrew Turner         m_pMsgLogger->LogMsg(msg);
75*c120c564SAndrew Turner }
76*c120c564SAndrew Turner 
setTestWaits(const int num_waits)77*c120c564SAndrew Turner inline void ItemPrinter::setTestWaits(const int num_waits)
78*c120c564SAndrew Turner {
79*c120c564SAndrew Turner     m_test_waits = num_waits;
80*c120c564SAndrew Turner }
81*c120c564SAndrew Turner 
getTestWaits()82*c120c564SAndrew Turner inline const int ItemPrinter::getTestWaits() const
83*c120c564SAndrew Turner {
84*c120c564SAndrew Turner     return m_test_waits;
85*c120c564SAndrew Turner }
86*c120c564SAndrew Turner 
decTestWaits()87*c120c564SAndrew Turner inline void ItemPrinter::decTestWaits()
88*c120c564SAndrew Turner {
89*c120c564SAndrew Turner     m_test_waits--;
90*c120c564SAndrew Turner }
91*c120c564SAndrew Turner 
92*c120c564SAndrew Turner #endif // ARM_ITEM_PRINTER_H_INCLUDED
93*c120c564SAndrew Turner 
94*c120c564SAndrew Turner /* End of File item_printer.h */
95