Skip to content

Commit e816c36

Browse files
iox-#1391 Move builder.hpp to design folder
Signed-off-by: Marika Lehmann <[email protected]>
1 parent 1b4017a commit e816c36

File tree

9 files changed

+36
-11
lines changed

9 files changed

+36
-11
lines changed

doc/website/release-notes/iceoryx-unreleased.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
- posix wrapper `SharedMemoryObject` is silent on success [\#971](https://github.com/eclipse-iceoryx/iceoryx/issues/971)
7878
- Remove creation design pattern class with in place implementation [\#1036](https://github.com/eclipse-iceoryx/iceoryx/issues/1036)
7979
- posix wrapper `SharedMemoryObject` uses builder pattern instead of creation
80-
- Builder pattern extracted from `helplets.hpp` into `design_pattern/builder.hpp`
80+
- Builder pattern extracted from `helplets.hpp` into `iox/builder.hpp`
8181
- Uninteresting mock function calls in tests [\#1341](https://github.com/eclipse-iceoryx/iceoryx/issues/1341)
8282
- `cxx::unique_ptr` owns deleter, remove all deleter classes [\#1143](https://github.com/eclipse-iceoryx/iceoryx/issues/1143)
8383
- Remove `iox::posix::Timer` [\#337](https://github.com/eclipse-iceoryx/iceoryx/issues/337)
@@ -146,14 +146,14 @@
146146
.create();
147147
```
148148

149-
2. Builder pattern extracted from `helplets.hpp` into `design_pattern/builder.hpp`
149+
2. Builder pattern extracted from `helplets.hpp` into `iox/builder.hpp`
150150

151151
```cpp
152152
// before
153153
#include "iceoryx_hoofs/cxx/helplets.hpp"
154154

155155
// after
156-
#include "iceoryx_hoofs/design_pattern/builder.hpp"
156+
#include "iox/builder.hpp"
157157
```
158158

159159
3. `UnnamedSemaphore` replaces `Semaphore` with `CreateUnnamed*` option

iceoryx_hoofs/include/iceoryx_hoofs/design_pattern/builder.hpp renamed to iceoryx_hoofs/design/include/iox/builder.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
//
1515
// SPDX-License-Identifier: Apache-2.0
1616

17-
#ifndef IOX_HOOFS_DESIGN_PATTERN_BUILDER_HPP
18-
#define IOX_HOOFS_DESIGN_PATTERN_BUILDER_HPP
17+
#ifndef IOX_HOOFS_DESIGN_BUILDER_HPP
18+
#define IOX_HOOFS_DESIGN_BUILDER_HPP
1919

2020
/// @brief Macro which generates a setter method useful for a builder pattern.
2121
/// @param[in] type the data type of the parameter

iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/mutex.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
#ifndef IOX_HOOFS_POSIX_WRAPPER_MUTEX_HPP
1818
#define IOX_HOOFS_POSIX_WRAPPER_MUTEX_HPP
1919

20-
#include "iceoryx_hoofs/design_pattern/builder.hpp"
2120
#include "iceoryx_platform/pthread.hpp"
21+
#include "iox/builder.hpp"
2222
#include "iox/expected.hpp"
2323
#include "iox/optional.hpp"
2424

iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/shared_memory_object/shared_memory.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
#define IOX_HOOFS_POSIX_WRAPPER_SHARED_MEMORY_OBJECT_SHARED_MEMORY_HPP
1919

2020
#include "iceoryx_hoofs/cxx/filesystem.hpp"
21-
#include "iceoryx_hoofs/design_pattern/builder.hpp"
2221
#include "iceoryx_hoofs/posix_wrapper/types.hpp"
22+
#include "iox/builder.hpp"
2323
#include "iox/expected.hpp"
2424
#include "iox/optional.hpp"
2525
#include "iox/string.hpp"

iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/file_lock.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
#define IOX_HOOFS_POSIX_WRAPPER_FILE_LOCK_HPP
1818

1919
#include "iceoryx_hoofs/cxx/filesystem.hpp"
20-
#include "iceoryx_hoofs/design_pattern/builder.hpp"
2120
#include "iceoryx_platform/file.hpp"
21+
#include "iox/builder.hpp"
2222
#include "iox/expected.hpp"
2323
#include "iox/string.hpp"
2424

iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/named_semaphore.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717
#define IOX_HOOFS_POSIX_WRAPPER_NAMED_SEMAPHORE_HPP
1818

1919
#include "iceoryx_hoofs/cxx/filesystem.hpp"
20-
#include "iceoryx_hoofs/design_pattern/builder.hpp"
2120
#include "iceoryx_hoofs/internal/posix_wrapper/semaphore_interface.hpp"
2221
#include "iceoryx_hoofs/posix_wrapper/types.hpp"
2322
#include "iceoryx_platform/platform_settings.hpp"
23+
#include "iox/builder.hpp"
2424
#include "iox/expected.hpp"
2525
#include "iox/optional.hpp"
2626
#include "iox/string.hpp"

iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/thread.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
#define IOX_HOOFS_POSIX_WRAPPER_PTHREAD_HPP
1818

1919
#include "iceoryx_hoofs/cxx/function.hpp"
20-
#include "iceoryx_hoofs/design_pattern/builder.hpp"
2120
#include "iceoryx_hoofs/posix_wrapper/posix_call.hpp"
2221
#include "iceoryx_platform/pthread.hpp"
22+
#include "iox/builder.hpp"
2323
#include "iox/expected.hpp"
2424
#include "iox/string.hpp"
2525

iceoryx_hoofs/include/iceoryx_hoofs/posix_wrapper/unnamed_semaphore.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
#ifndef IOX_HOOFS_POSIX_WRAPPER_UNNAMED_SEMAPHORE_HPP
1717
#define IOX_HOOFS_POSIX_WRAPPER_UNNAMED_SEMAPHORE_HPP
1818

19-
#include "iceoryx_hoofs/design_pattern/builder.hpp"
2019
#include "iceoryx_hoofs/internal/posix_wrapper/semaphore_interface.hpp"
20+
#include "iox/builder.hpp"
2121
#include "iox/expected.hpp"
2222
#include "iox/optional.hpp"
2323

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Copyright (c) 2023 by Apex.AI Inc. All rights reserved.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
//
15+
// SPDX-License-Identifier: Apache-2.0
16+
17+
#ifndef IOX_HOOFS_DESIGN_PATTERN_BUILDER_HPP
18+
#define IOX_HOOFS_DESIGN_PATTERN_BUILDER_HPP
19+
20+
#include "iox/builder.hpp"
21+
/// @todo iox-#1593 Deprecate include
22+
/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/builder.hpp' instead")]]
23+
24+
#endif
25+

0 commit comments

Comments
 (0)