1 /*---------------------------------------------------------------------------*
2 
3   Project:  OLV
4   File:     olv_Report.h
5 
6   Copyright (C) 2009-2013 Nintendo. All rights reserved.
7 
8   These coded instructions, statements, and computer programs contain
9   proprietary information of Nintendo of America Inc. and/or Nintendo
10   Company Ltd., and are protected by Federal copyright law.  They may
11   not be disclosed to third parties or copied or duplicated in any form,
12   in whole or in part, without the prior written consent of Nintendo.
13 
14  *---------------------------------------------------------------------------*/
15 //------------------------------------------------------------------------------
16 /** @file   olv_Report.h
17  *
18  *  @brief  OLV Handles debugging information and other output by the OLV library.
19  *
20  */
21 //------------------------------------------------------------------------------
22 #ifndef __OLV_REPORT_H_
23 #define __OLV_REPORT_H_
24 
25 /// <span>nn</span>
26 namespace nn {
27 
28 /// <span>olv</span>
29 namespace olv {
30 
31 /// <span>Report</span>
32 namespace Report {
33 
34 /** @defgroup type  Types
35  *  @{
36  */
37 
38 /// Print callback function.
39 /// Make it so the display strings can be passed to the application
40 /// The application can alter the strings or save them to a file, and so on.
41 typedef void (*fpPrintCallback)(const char*);
42 
43 /** @} */
44 
45 /** @defgroup function  Static Functions
46  *  @{
47  */
48 
49 //------------------------------------------------------------------------------
50 /**
51  *  Gets the currently configured combination to output reports.
52  *
53  *  @return Combination of <tt>ReportType</tt> constants.
54  */
55 u32 GetReportTypes();
56 
57 //------------------------------------------------------------------------------
58 /**
59  *  Sets the print callback.
60  *
61  *  @param[in]  callback  Pointer to the callback function used by the application. <br/>
62  *                        Specify <tt>NULL</tt> to output on the standard output.
63  */
64 void SetPrintCallback(fpPrintCallback callback);
65 
66 /** @} */
67 
68 }
69 }
70 }   // end of namespace
71 
72 
73 #endif  // __OLV_REPORT_H_
74 
75