Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/global/management/src/G4BuffercoutDestination.cc

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /global/management/src/G4BuffercoutDestination.cc (Version 11.3.0) and /global/management/src/G4BuffercoutDestination.cc (Version 11.2.1)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                         3 // * License and Disclaimer                                           *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th      5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided      6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License      7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/      8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.           9 // * include a list of copyright holders.                             *
 10 // *                                               10 // *                                                                  *
 11 // * Neither the authors of this software syst     11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file      15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitatio     16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                               17 // *                                                                  *
 18 // * This  code  implementation is the result      18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboratio     19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distri     20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  ag     21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publicati     22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Sof     23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // *******************************************     24 // ********************************************************************
 25 //                                                 25 //
 26 // G4BuffercoutDestination class implementatio     26 // G4BuffercoutDestination class implementation
 27 //                                                 27 //
 28 // Author: A.Dotti (SLAC), 14 April 2017           28 // Author: A.Dotti (SLAC), 14 April 2017
 29 // -------------------------------------------     29 // --------------------------------------------------------------------
 30                                                    30 
 31 #include "G4BuffercoutDestination.hh"              31 #include "G4BuffercoutDestination.hh"
 32                                                    32 
 33 #include "G4AutoLock.hh"                           33 #include "G4AutoLock.hh"
 34                                                    34 
 35 #include <iostream>                                35 #include <iostream>
 36                                                    36 
 37 // Private class to implement buffering of log     37 // Private class to implement buffering of logging via an ostringstream
 38 class G4BuffercoutDestination::BufferImpl          38 class G4BuffercoutDestination::BufferImpl
 39 {                                                  39 {
 40  public:                                           40  public:
 41   using FlushFn_t = std::function<void(const s     41   using FlushFn_t = std::function<void(const std::string&)>;
 42                                                    42 
 43  public:                                           43  public:
 44   explicit BufferImpl(std::size_t maxSize) : m     44   explicit BufferImpl(std::size_t maxSize) : m_maxSize(maxSize) {}
 45   explicit BufferImpl(std::size_t maxSize, Flu <<  45   explicit BufferImpl(std::size_t maxSize, FlushFn_t&& f) : m_maxSize(maxSize), m_flushFn(f) {}
 46                                                    46 
 47   ~BufferImpl() = default;                         47   ~BufferImpl() = default;
 48                                                    48 
 49   // Set number of characters to hold before F     49   // Set number of characters to hold before Flush() will be called
 50   // If buffer exceeds new maximum, Flush() wi     50   // If buffer exceeds new maximum, Flush() will not be called until next call to Receive()
 51   void SetMaxSize(std::size_t n) { m_maxSize =     51   void SetMaxSize(std::size_t n) { m_maxSize = n; }
 52                                                    52 
 53   // Reset buffer without flushing                 53   // Reset buffer without flushing
 54   void Reset()                                     54   void Reset()
 55   {                                                55   {
 56     m_buffer.str("");                              56     m_buffer.str("");
 57     m_buffer.clear();                              57     m_buffer.clear();
 58     m_currentSize = 0;                             58     m_currentSize = 0;
 59   }                                                59   }
 60                                                    60 
 61   G4int Receive(const G4String& msg)               61   G4int Receive(const G4String& msg)
 62   {                                                62   {
 63     m_currentSize += msg.size();                   63     m_currentSize += msg.size();
 64     m_buffer << msg;                               64     m_buffer << msg;
 65                                                    65 
 66     if (m_maxSize > 0 && m_currentSize > m_max     66     if (m_maxSize > 0 && m_currentSize > m_maxSize) {
 67       return Flush();                              67       return Flush();
 68     }                                              68     }
 69     return 0;                                      69     return 0;
 70   }                                                70   }
 71                                                    71 
 72   // Flush buffer to destination and reset it      72   // Flush buffer to destination and reset it
 73   G4int Flush()                                    73   G4int Flush()
 74   {                                                74   {
 75     m_flushFn(m_buffer.str());                     75     m_flushFn(m_buffer.str());
 76     Reset();                                       76     Reset();
 77     return 0;                                      77     return 0;
 78   }                                                78   }
 79                                                    79 
 80  private:                                          80  private:
 81   std::size_t m_maxSize = 0;                       81   std::size_t m_maxSize = 0;
 82   std::ostringstream m_buffer;                     82   std::ostringstream m_buffer;
 83   std::size_t m_currentSize = 0;                   83   std::size_t m_currentSize = 0;
 84   FlushFn_t m_flushFn = [](auto& s) { std::cou     84   FlushFn_t m_flushFn = [](auto& s) { std::cout << s << std::flush; };
 85 };                                                 85 };
 86                                                    86 
 87 // -------------------------------------------     87 // --------------------------------------------------------------------
 88 G4BuffercoutDestination::G4BuffercoutDestinati     88 G4BuffercoutDestination::G4BuffercoutDestination(std::size_t max)
 89   : m_maxSize(max),                                89   : m_maxSize(max),
 90     m_buffer_dbg(std::make_unique<BufferImpl>(     90     m_buffer_dbg(std::make_unique<BufferImpl>(max)),
 91     m_buffer_out(std::make_unique<BufferImpl>(     91     m_buffer_out(std::make_unique<BufferImpl>(max)),
 92     m_buffer_err(std::make_unique<BufferImpl>(     92     m_buffer_err(std::make_unique<BufferImpl>(max, [](auto& s) { std::cerr << s << std::flush; }))
 93 {}                                                 93 {}
 94                                                    94 
 95 // -------------------------------------------     95 // --------------------------------------------------------------------
 96 G4BuffercoutDestination::~G4BuffercoutDestinat     96 G4BuffercoutDestination::~G4BuffercoutDestination() { Finalize(); }
 97                                                    97 
 98 // -------------------------------------------     98 // --------------------------------------------------------------------
 99 void G4BuffercoutDestination::Finalize()           99 void G4BuffercoutDestination::Finalize()
100 {                                                 100 {
101   FlushG4cerr();                                  101   FlushG4cerr();
102   FlushG4cout();                                  102   FlushG4cout();
103   FlushG4debug();                                 103   FlushG4debug();
104 }                                                 104 }
105                                                   105 
106 // -------------------------------------------    106 // --------------------------------------------------------------------
107 G4int G4BuffercoutDestination::ReceiveG4debug(    107 G4int G4BuffercoutDestination::ReceiveG4debug(const G4String& msg)
108 {                                                 108 {
109   return m_buffer_dbg->Receive(msg);              109   return m_buffer_dbg->Receive(msg);
110 }                                                 110 }
111                                                   111 
112 // -------------------------------------------    112 // --------------------------------------------------------------------
113 G4int G4BuffercoutDestination::ReceiveG4cout(c    113 G4int G4BuffercoutDestination::ReceiveG4cout(const G4String& msg)
114 {                                                 114 {
115   return m_buffer_out->Receive(msg);              115   return m_buffer_out->Receive(msg);
116 }                                                 116 }
117                                                   117 
118 // -------------------------------------------    118 // --------------------------------------------------------------------
119 G4int G4BuffercoutDestination::ReceiveG4cerr(c    119 G4int G4BuffercoutDestination::ReceiveG4cerr(const G4String& msg)
120 {                                                 120 {
121   return m_buffer_err->Receive(msg);              121   return m_buffer_err->Receive(msg);
122 }                                                 122 }
123                                                   123 
124 // -------------------------------------------    124 // --------------------------------------------------------------------
125 G4int G4BuffercoutDestination::FlushG4debug()     125 G4int G4BuffercoutDestination::FlushG4debug()
126 {                                                 126 {
127   return m_buffer_dbg->Flush();                   127   return m_buffer_dbg->Flush();
128 }                                                 128 }
129                                                   129 
130 // -------------------------------------------    130 // --------------------------------------------------------------------
131 G4int G4BuffercoutDestination::FlushG4cout()      131 G4int G4BuffercoutDestination::FlushG4cout()
132 {                                                 132 {
133   return m_buffer_out->Flush();                   133   return m_buffer_out->Flush();
134 }                                                 134 }
135                                                   135 
136 // -------------------------------------------    136 // --------------------------------------------------------------------
137 G4int G4BuffercoutDestination::FlushG4cerr()      137 G4int G4BuffercoutDestination::FlushG4cerr()
138 {                                                 138 {
139   return m_buffer_err->Flush();                   139   return m_buffer_err->Flush();
140 }                                                 140 }
141                                                   141 
142 // -------------------------------------------    142 // --------------------------------------------------------------------
143 void G4BuffercoutDestination::SetMaxSize(std::    143 void G4BuffercoutDestination::SetMaxSize(std::size_t max)
144 {                                                 144 {
145   m_maxSize = max;                                145   m_maxSize = max;
146   m_buffer_dbg->SetMaxSize(m_maxSize);            146   m_buffer_dbg->SetMaxSize(m_maxSize);
147   m_buffer_out->SetMaxSize(m_maxSize);            147   m_buffer_out->SetMaxSize(m_maxSize);
148   m_buffer_err->SetMaxSize(m_maxSize);            148   m_buffer_err->SetMaxSize(m_maxSize);
149 }                                                 149 }
150                                                   150