Skip to content
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
6 changes: 3 additions & 3 deletions docs/features/baselibs/docs/architecture/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Static Architecture
:security: YES
:safety: ASIL_B
:status: valid
:includes: logic_arc_int__baselibs__json, logic_arc_int__baselibs__memory_shared, logic_arc_int__baselibs__message_passing, logic_arc_int__baselibs__result, logic_arc_int__baselibs__bit_manipulation, logic_arc_int__baselibs__bit_mask_operator, logic_arc_int__baselibs__dynamic_array, logic_arc_int__baselibs__intrusive_list, logic_arc_int__baselibs__filesystem, logic_arc_int__baselibs__utils_base64, logic_arc_int__baselibs__utils_scoped_op, logic_arc_int__baselibs__promise, logic_arc_int__baselibs__future, logic_arc_int__baselibs__shared_future, logic_arc_int__baselibs__executor, logic_arc_int__baselibs__task, logic_arc_int__baselibs__task_result, logic_arc_int__baselibs__synchronized_queue, logic_arc_int__baselibs__condition_variable
:includes: logic_arc_int__baselibs__json, logic_arc_int__baselibs__memory_shared, logic_arc_int__baselibs__message_passing, logic_arc_int__baselibs__result, logic_arc_int__baselibs__bit_manipulation, logic_arc_int__baselibs__bit_mask_operator, logic_arc_int__baselibs__dynamic_array, logic_arc_int__baselibs__intrusive_list, logic_arc_int__baselibs__filesystem, logic_arc_int__baselibs__utils_base64, logic_arc_int__baselibs__utils_scoped_op, logic_arc_int__baselibs__promise, logic_arc_int__baselibs__future, logic_arc_int__baselibs__shared_future, logic_arc_int__baselibs__executor, logic_arc_int__baselibs__task, logic_arc_int__baselibs__task_result, logic_arc_int__baselibs__synchronized_queue, logic_arc_int__baselibs__condition_variable, logic_arc_int__safecpp__aborts_upon_ex, logic_arc_int__safecpp__coverage_termination, logic_arc_int__baselibs__safemath, logic_arc_int__baselibs__safeatomics, logic_arc_int__baselibs__scoped_function, logic_arc_int__baselibs__string_view
:consists_of: comp__com_configuration, comp__com_ipc_binding, comp__com_mock_binding, comp__com_frontend

.. feat_arc_sta:: Baselibs Static View
Expand All @@ -98,7 +98,7 @@ Static Architecture
:safety: ASIL_B
:status: valid
:fulfils: feat_req__baselibs__core_utilities
:includes: logic_arc_int__baselibs__json, logic_arc_int__baselibs__memory_shared, logic_arc_int__baselibs__message_passing, logic_arc_int__baselibs__result, logic_arc_int__baselibs__bit_manipulation, logic_arc_int__baselibs__bit_mask_operator, logic_arc_int__baselibs__dynamic_array, logic_arc_int__baselibs__intrusive_list, logic_arc_int__baselibs__filesystem, logic_arc_int__baselibs__utils_base64, logic_arc_int__baselibs__utils_scoped_op, logic_arc_int__baselibs__promise, logic_arc_int__baselibs__future, logic_arc_int__baselibs__shared_future, logic_arc_int__baselibs__executor, logic_arc_int__baselibs__task, logic_arc_int__baselibs__task_result, logic_arc_int__baselibs__synchronized_queue, logic_arc_int__baselibs__condition_variable
:includes: logic_arc_int__baselibs__json, logic_arc_int__baselibs__memory_shared, logic_arc_int__baselibs__message_passing, logic_arc_int__baselibs__result, logic_arc_int__baselibs__bit_manipulation, logic_arc_int__baselibs__bit_mask_operator, logic_arc_int__baselibs__dynamic_array, logic_arc_int__baselibs__intrusive_list, logic_arc_int__baselibs__filesystem, logic_arc_int__baselibs__utils_base64, logic_arc_int__baselibs__utils_scoped_op, logic_arc_int__baselibs__promise, logic_arc_int__baselibs__future, logic_arc_int__baselibs__shared_future, logic_arc_int__baselibs__executor, logic_arc_int__baselibs__task, logic_arc_int__baselibs__task_result, logic_arc_int__baselibs__synchronized_queue, logic_arc_int__baselibs__condition_variable, logic_arc_int__safecpp__aborts_upon_ex, logic_arc_int__safecpp__coverage_termination, logic_arc_int__baselibs__safemath, logic_arc_int__baselibs__safeatomics, logic_arc_int__baselibs__scoped_function, logic_arc_int__baselibs__string_view
:tags: inspected
:belongs_to: feat__baselibs

Expand All @@ -117,4 +117,4 @@ The Baselibs feature exposes the following logical interfaces:
:style: table
:columns: title;id;status
:sort: title
:filter: id in ['logic_arc_int__baselibs__json', 'logic_arc_int__baselibs__memory_shared', 'logic_arc_int__baselibs__message_passing' ,'logic_arc_int__baselibs__result', 'logic_arc_int__baselibs__bit_manipulation', 'logic_arc_int__baselibs__bit_mask_operator', 'logic_arc_int__baselibs__dynamic_array', 'logic_arc_int__baselibs__intrusive_list', 'logic_arc_int__baselibs__filesystem', 'logic_arc_int__baselibs__utils_base64', 'logic_arc_int__baselibs__utils_scoped_op', 'logic_arc_int__baselibs__promise', 'logic_arc_int__baselibs__future', 'logic_arc_int__baselibs__shared_future', 'logic_arc_int__baselibs__executor', 'logic_arc_int__baselibs__task', 'logic_arc_int__baselibs__task_result', 'logic_arc_int__baselibs__synchronized_queue', 'logic_arc_int__baselibs__condition_variable']
:filter: id in ['logic_arc_int__baselibs__json', 'logic_arc_int__baselibs__memory_shared', 'logic_arc_int__baselibs__message_passing' ,'logic_arc_int__baselibs__result', 'logic_arc_int__baselibs__bit_manipulation', 'logic_arc_int__baselibs__bit_mask_operator', 'logic_arc_int__baselibs__dynamic_array', 'logic_arc_int__baselibs__intrusive_list', 'logic_arc_int__baselibs__filesystem', 'logic_arc_int__baselibs__utils_base64', 'logic_arc_int__baselibs__utils_scoped_op', 'logic_arc_int__baselibs__promise', 'logic_arc_int__baselibs__future', 'logic_arc_int__baselibs__shared_future', 'logic_arc_int__baselibs__executor', 'logic_arc_int__baselibs__task', 'logic_arc_int__baselibs__task_result', 'logic_arc_int__baselibs__synchronized_queue', 'logic_arc_int__baselibs__condition_variable', 'logic_arc_int__safecpp__aborts_upon_ex', 'logic_arc_int__safecpp__coverage_termination', 'logic_arc_int__baselibs__safemath', 'logic_arc_int__baselibs__safeatomics', 'logic_arc_int__baselibs__scoped_function', 'logic_arc_int__baselibs__string_view']
4 changes: 2 additions & 2 deletions docs/modules/baselibs/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@

.. mod:: Baselibs
:id: mod__baselibs
:includes: comp__baselibs_json, comp__baselibs_message_passing, comp__baselibs_memory_shared, comp__baselibs_result, comp__baselibs_bit_manipulation, comp__baselibs_containers, comp__baselibs_filesystem, comp__baselibs_utils, comp__baselibs_concurrency
:includes: comp__baselibs_json, comp__baselibs_message_passing, comp__baselibs_memory_shared, comp__baselibs_result, comp__baselibs_bit_manipulation, comp__baselibs_containers, comp__baselibs_filesystem, comp__baselibs_utils, comp__baselibs_concurrency, comp__baselibs_safecpp
:status: valid
:safety: ASIL_B
:security: YES

.. mod_view_sta:: Baselibs Static View
:id: mod_view_sta__baselibs__baselibs
:includes: comp__baselibs_json, comp__baselibs_message_passing, comp__baselibs_memory_shared, comp__baselibs_result, comp__baselibs_bit_manipulation, comp__baselibs_containers, comp__baselibs_filesystem, comp__baselibs_utils, comp__baselibs_concurrency
:includes: comp__baselibs_json, comp__baselibs_message_passing, comp__baselibs_memory_shared, comp__baselibs_result, comp__baselibs_bit_manipulation, comp__baselibs_containers, comp__baselibs_filesystem, comp__baselibs_utils, comp__baselibs_concurrency, comp__baselibs_safecpp

.. needarch::
:scale: 50
Expand Down
230 changes: 230 additions & 0 deletions docs/modules/baselibs/language/safecpp/docs/architecture/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
..
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Safecpp Component Architecture
********************************

.. document:: Safecpp Architecture
:id: doc__safecpp_architecture
:status: valid
:safety: ASIL_B
:security: YES
:realizes: wp__component_arch

Overview/Description
--------------------

see :need:`doc__safecpp_architecture`

Static Architecture
-------------------

.. comp:: SafeCpp
:id: comp__baselibs_safecpp
:security: YES
:safety: ASIL_B
:status: valid
:tags: baselibs_safecpp
:implements: logic_arc_int__safecpp__aborts_upon_ex, logic_arc_int__safecpp__coverage_termination, logic_arc_int__baselibs__safemath, logic_arc_int__baselibs__safeatomics, logic_arc_int__baselibs__scoped_function, logic_arc_int__baselibs__string_view

.. needarch::
:scale: 50
:align: center

{{ draw_component(need(), needs) }}

Interfaces
----------
.. logic_arc_int:: Aborts Upon Exception
:id: logic_arc_int__safecpp__aborts_upon_ex
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Allocate exception
:id: logic_arc_int_op__safecpp__allocate_exception
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__safecpp__aborts_upon_ex

.. logic_arc_int:: Coverage Termination Handler
:id: logic_arc_int__safecpp__coverage_termination
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Terminate_handler
:id: logic_arc_int_op__safecpp__terminate_handler
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__safecpp__coverage_termination

.. logic_arc_int_op:: Signal_handler
:id: logic_arc_int_op__safecpp__signal_handler
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__safecpp__coverage_termination

.. logic_arc_int:: Safe Math
:id: logic_arc_int__baselibs__safemath
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Add
:id: logic_arc_int_op__safecpp__safemath_add
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Subtract
:id: logic_arc_int_op__safecpp__safemath_subtract
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Multiply
:id: logic_arc_int_op__safecpp__safemath_multiply
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Divide
:id: logic_arc_int_op__safecpp__safemath_divide
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Negate
:id: logic_arc_int_op__safecpp__safemath_negate
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Abs
:id: logic_arc_int_op__safecpp__safemath_abs
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Cast
:id: logic_arc_int_op__safecpp__safemath_cast
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Less
:id: logic_arc_int_op__safecpp__safemath_less
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Greater
:id: logic_arc_int_op__safecpp__safemath_greater
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Equal
:id: logic_arc_int_op__safecpp__safemath_equal
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Notequal
:id: logic_arc_int_op__safecpp__safemath_notequal
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Lessequal
:id: logic_arc_int_op__safecpp__safemath_lessequal
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int_op:: Greaterequal
:id: logic_arc_int_op__safecpp__safemath_greatereq
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safemath

.. logic_arc_int:: Safe Atomics
:id: logic_arc_int__baselibs__safeatomics
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Atomic Add
:id: logic_arc_int_op__safecpp__safeatomics_atomic
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__safeatomics

.. logic_arc_int:: Scoped Function
:id: logic_arc_int__baselibs__scoped_function
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Move Only Scoped Function
:id: logic_arc_int_op__safecpp__scoped_function_mo
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__scoped_function

.. logic_arc_int_op:: Copyable Scoped Function
:id: logic_arc_int_op__safecpp__scoped_function_co
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__scoped_function

.. logic_arc_int_op:: Expire
:id: logic_arc_int_op__safecpp__scoped_function_ex
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__scoped_function

.. logic_arc_int:: String View
:id: logic_arc_int__baselibs__string_view
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Null Termination Check
:id: logic_arc_int_op__safecpp__string_view_null
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__string_view
3 changes: 2 additions & 1 deletion docs/modules/baselibs/language/safecpp/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************


safecpp
#######

Expand All @@ -28,6 +27,8 @@ safecpp
.. toctree::
:hidden:

architecture/index.rst

Abstract
========

Expand Down