| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4coutFormatters
27 //
28 // Description:
29 //
30 // Utilities to handle transformations of cout/cerr streams
31
32 // ---------------- G4coutFormatters ----------------
33 //
34 // Author: A.Dotti (SLAC), April 2017
35 // --------------------------------------------------------------------
36 #ifndef G4COUTFORMATTERS_HH
37 #define G4COUTFORMATTERS_HH 1
38
39 #include <algorithm>
40 #include <ctime>
41 #include <functional>
42 #include <iomanip>
43 #include <sstream>
44 #include <unordered_map>
45 #include <vector>
46
47 #include "G4String.hh"
48 #include "G4ios.hh"
49 #include "G4coutDestination.hh"
50
51 namespace G4coutFormatters
52 {
53 // Static definitions of provided formatters
54 namespace ID
55 {
56 static const G4String SYSLOG = "syslog";
57 static const G4String DEFAULT = "default";
58 } // namespace ID
59
60 using SetupStyle_f = std::function<G4int(G4coutDestination*)>;
61 // A function that set ups a style for the destination
62 // Example for a style that set to all capital the messages
63 // to G4cerr:
64 // setupStyle_f myStyle = [](G4coutDestination* dest)->G4int {
65 // dest->SetCerrTransformer(
66 // [](G4String& msg){
67 // msg->toUpper();
68 // return true; }
69 // );
70 // };
71
72 using String_V = std::vector<G4String>;
73
74 String_V Names();
75 // Return list of formatter names
76
77 G4int HandleStyle(G4coutDestination* dest, const G4String& style);
78 // Setup style (by name) to destination
79
80 void SetMasterStyle(const G4String&);
81 G4String GetMasterStyle();
82 // Set/get name of the style for the master thread
83
84 void SetupStyleGlobally(const G4String& news);
85 // This function should be called in user application main function
86 // to setup the style just after setting up RunManager
87
88 void RegisterNewStyle(const G4String& name, SetupStyle_f& formatter);
89 // To be used by user to register by name a new formatter.
90 // So it can be used via one of the previous functions
91 } // namespace G4coutFormatters
92
93 #endif
94