Skip to content

Commit 97088e8

Browse files
committed
feat: add forward declaration header
1 parent bd43e0c commit 97088e8

2 files changed

Lines changed: 82 additions & 0 deletions

File tree

includes/sjson/fwd.h

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#pragma once
2+
3+
////////////////////////////////////////////////////////////////////////////////
4+
// The MIT License (MIT)
5+
//
6+
// Copyright (c) 2022 Nicholas Frechette, Cody Jones, and sjson-cpp contributors
7+
//
8+
// Permission is hereby granted, free of charge, to any person obtaining a copy
9+
// of this software and associated documentation files (the "Software"), to deal
10+
// in the Software without restriction, including without limitation the rights
11+
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
// copies of the Software, and to permit persons to whom the Software is
13+
// furnished to do so, subject to the following conditions:
14+
//
15+
// The above copyright notice and this permission notice shall be included in all
16+
// copies or substantial portions of the Software.
17+
//
18+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24+
// SOFTWARE.
25+
////////////////////////////////////////////////////////////////////////////////
26+
27+
#include "sjson/version.h"
28+
29+
////////////////////////////////////////////////////////////////////////////////
30+
// This header provides forward declarations for all public sjson-cpp types.
31+
// Forward declaring symbols from a 3rd party library is a bad idea, use this
32+
// header instead.
33+
// See also: https://blog.libtorrent.org/2017/12/forward-declarations-and-abi/
34+
////////////////////////////////////////////////////////////////////////////////
35+
36+
namespace sjson
37+
{
38+
SJSON_CPP_IMPL_VERSION_NAMESPACE_BEGIN
39+
40+
// Core
41+
class runtime_assert;
42+
class StringView;
43+
44+
// Parser
45+
struct ParserError;
46+
struct ParserState;
47+
struct Parser;
48+
49+
// Writer
50+
class StreamWriter;
51+
class FileStreamWriter;
52+
class ArrayWriter;
53+
class ObjectWriter;
54+
class Writer;
55+
56+
SJSON_CPP_IMPL_VERSION_NAMESPACE_END
57+
}

tests/sources/test_header_fwd.cpp

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
////////////////////////////////////////////////////////////////////////////////
2+
// The MIT License (MIT)
3+
//
4+
// Copyright (c) 2022 Nicholas Frechette, Cody Jones, and sjson-cpp contributors
5+
//
6+
// Permission is hereby granted, free of charge, to any person obtaining a copy
7+
// of this software and associated documentation files (the "Software"), to deal
8+
// in the Software without restriction, including without limitation the rights
9+
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
// copies of the Software, and to permit persons to whom the Software is
11+
// furnished to do so, subject to the following conditions:
12+
//
13+
// The above copyright notice and this permission notice shall be included in all
14+
// copies or substantial portions of the Software.
15+
//
16+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
// SOFTWARE.
23+
////////////////////////////////////////////////////////////////////////////////
24+
25+
#include <sjson/fwd.h>

0 commit comments

Comments
 (0)