1 
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2010-2013 Francois Beaune, Jupiter Jazz Limited
9 // Copyright (c) 2014-2018 Francois Beaune, The appleseedhq Organization
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining a copy
12 // of this software and associated documentation files (the "Software"), to deal
13 // in the Software without restriction, including without limitation the rights
14 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 // copies of the Software, and to permit persons to whom the Software is
16 // furnished to do so, subject to the following conditions:
17 //
18 // The above copyright notice and this permission notice shall be included in
19 // all copies or substantial portions of the Software.
20 //
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 // THE SOFTWARE.
28 //
29 
30 #pragma once
31 
32 // appleseed.foundation headers.
33 #include "foundation/platform/compiler.h"
34 #include "foundation/utility/log/ilogtarget.h"
35 #include "foundation/utility/log/logmessage.h"
36 
37 // appleseed.main headers.
38 #include "main/dllsymbol.h"
39 
40 // Standard headers.
41 #include <cstddef>
42 
43 namespace foundation
44 {
45 
46 //
47 // A log target that outputs to a string.
48 //
49 
50 class APPLESEED_DLLSYMBOL StringLogTarget
51   : public ILogTarget
52 {
53   public:
54     // Constructor.
55     StringLogTarget();
56 
57     // Destructor.
58     ~StringLogTarget() override;
59 
60     // Delete this instance.
61     void release() override;
62 
63     // Write a message.
64     void write(
65         const LogMessage::Category  category,
66         const char*                 file,
67         const size_t                line,
68         const char*                 header,
69         const char*                 message) override;
70 
71     // Retrieve the string so far.
72     const char* get_string() const;
73 
74   private:
75     struct Impl;
76     Impl* impl;
77 };
78 
79 // Create an instance of a log target that outputs to a string.
80 APPLESEED_DLLSYMBOL StringLogTarget* create_string_log_target();
81 
82 }   // namespace foundation
83