| 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 // G4coutDestination
27 //
28 // Class description:
29 //
30 // Cout/cerr buffer containers
31
32 // Authors: H.Yoshida, M.Nagamatu - November 1998
33 // --------------------------------------------------------------------
34 #ifndef G4COUTDESTINATION_HH
35 #define G4COUTDESTINATION_HH 1
36
37 #include <algorithm>
38 #include <functional>
39 #include <iostream>
40 #include <vector>
41
42 #include "globals.hh"
43
44 class G4coutDestination
45 {
46 public:
47
48 G4coutDestination() = default;
49 virtual ~G4coutDestination() = default;
50
51 // The type of the functions defining a transformation of the message.
52 // The function manipulates the input message, for example, to add a
53 // prefix:
54 // G4coutDestination::AddCoutTransformer(
55 // [](G4String& msg) -> G4bool { msg="PREFIX "+msg; return true; }
56 // );
57 // Function should return false if message should not be processed
58 // anymore and discarded
59 //
60 using Transformer = std::function<G4bool(G4String&)>;
61
62 void AddDebugTransformer(const Transformer& t)
63 {
64 transformersDebug.push_back(t);
65 }
66 void AddDebugTransformer(Transformer&& t) { transformersDebug.push_back(t); }
67
68 void AddCoutTransformer(const Transformer& t)
69 {
70 transformersCout.push_back(t);
71 }
72 void AddCoutTransformer(Transformer&& t) { transformersCout.push_back(t); }
73
74 void AddCerrTransformer(const Transformer& t)
75 {
76 transformersCerr.push_back(t);
77 }
78 void AddCerrTransformer(Transformer&& t) { transformersCerr.push_back(t); }
79 virtual void ResetTransformers();
80
81 virtual G4int ReceiveG4debug(const G4String& msg);
82 virtual G4int ReceiveG4cout(const G4String& msg);
83 virtual G4int ReceiveG4cerr(const G4String& msg);
84 // Derived class implements here handling of message.
85 // For example, streaming on std::cout or file.
86 // Return 0 for success, -1 otherwise
87
88 // Called by G4debug stream to handle log message
89 G4int ReceiveG4debug_(const G4String& msg);
90
91 G4int ReceiveG4cout_(const G4String& msg);
92 // Method called by G4strbuf when need to handle a message
93
94 G4int ReceiveG4cerr_(const G4String& msg);
95 // Transformers cannot remove an error message from stream
96
97 protected:
98
99 G4MTGLOB_DLL static G4coutDestination* masterG4coutDestination;
100 // For MT: if master G4coutDestination derived class wants to
101 // intercept the thread outputs, derived class should set this pointer.
102 // Needed for some G4UIsession like GUIs
103 std::vector<Transformer> transformersDebug;
104 std::vector<Transformer> transformersCout;
105 std::vector<Transformer> transformersCerr;
106 };
107
108 #endif
109