Skip to content

CXX-3231 add v1 forward headers and component files #1401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions src/bsoncxx/include/bsoncxx/docs/v1.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,67 @@
/// @warning For internal use only!
///

///
/// @dir bsoncxx/v1/array
/// Provides headers declaring entities in @ref bsoncxx::v1::array.
///
/// @warning For internal use only!
///

///
/// @dir bsoncxx/v1/document
/// Provides headers declaring entities in @ref bsoncxx::v1::document.
///
/// @warning For internal use only!
///

///
/// @dir bsoncxx/v1/element
/// Provides headers declaring entities in @ref bsoncxx::v1::element.
///
/// @warning For internal use only!
///

///
/// @dir bsoncxx/v1/stdx
/// Provides headers declaring entities in @ref bsoncxx::v1::stdx.
///

///
/// @dir bsoncxx/v1/types
/// Provides headers declaring entities in @ref bsoncxx::v1::types.
///
/// @warning For internal use only!
///

///
/// @namespace bsoncxx::v1
/// Declares entities whose ABI stability is guaranteed for documented symbols.
///

///
/// @namespace bsoncxx::v1::array
/// @copydoc bsoncxx::array
///

///
/// @namespace bsoncxx::v1::document
/// @copydoc bsoncxx::document
///

///
/// @namespace bsoncxx::v1::element
/// Declares entities representing a BSON element.
///

///
/// @namespace bsoncxx::v1::stdx
/// @copydoc bsoncxx::stdx
///

///
/// @namespace bsoncxx::v1::types
/// Declares entities representing a BSON type value.
///
/// @note A "BSON type value" refers to the value of a BSON element without its key.
///
34 changes: 34 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/value-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

class value;

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::array::value.
///
43 changes: 43 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/value.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/array/value-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

///
/// A BSON array.
///
/// @attention This feature is experimental! It is not ready for use!
///
class value {};

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::array::value.
///
34 changes: 34 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/view-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

class view;

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::array::view.
///
43 changes: 43 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/view.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/array/view-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

///
/// A non-owning, read-only BSON array.
///
/// @attention This feature is experimental! It is not ready for use!
///
class view {};

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::array::view.
///
32 changes: 32 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/decimal128-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {

class decimal128;

} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::decimal128.
///
41 changes: 41 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/decimal128.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/decimal128-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {

///
/// A BSON Decimal128.
///
/// @attention This feature is experimental! It is not ready for use!
///
class decimal128 {};

} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::decimal128.
///
34 changes: 34 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/document/value-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace document {

class value;

} // namespace document
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::document::value.
///
43 changes: 43 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/document/value.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <bsoncxx/v1/document/value-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace document {

///
/// A BSON document.
///
/// @attention This feature is experimental! It is not ready for use!
///
class value {};

} // namespace document
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::document::value.
///
Loading