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
10 changes: 8 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,14 @@
- Place opening braces on the **same line** as class, method, and namespace declarations.
- Do not use `using namespace`; qualify names with their namespaces (e.g., `std::`).
- Project headers come **before** system headers in include lists.
- Each header file must start with `#pragma once` followed by an include guard of the form `_SIMPLE_NAMED_PIPE_*_HPP_INCLUDED`.
- Each project-owned C/C++ header must start with `#pragma once` followed by a
non-reserved include guard derived from the project prefix and header path:
`SIMPLE_NAMED_PIPE_HEADER_<PATH>_<FILE>_<EXT>_INCLUDED`.
- Do not use guard names that start with an underscore, start with an underscore
followed by an uppercase letter, or contain a double underscore.
- Implementation fragments such as `.ipp`, `.inl`, or `.tpp` may remain
unguarded if they are only included from already guarded headers and are not
intended for direct inclusion.

## Constants and Macros

Expand All @@ -67,4 +74,3 @@
- `build:` – build system or dependency updates
- `ci:` – CI/CD configuration changes
- `chore:` – tasks that do not affect production code

6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeClient.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_CLIENT_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_CLIENT_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPECLIENT_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPECLIENT_HPP_INCLUDED

/// \file NamedPipeClient.hpp
/// \brief Synchronous named pipe client for tests and lightweight integrations.
Expand Down Expand Up @@ -132,4 +132,4 @@ namespace SimpleNamedPipe {
#include "NamedPipeClient/NamedPipeClient.ipp"
#endif

#endif // _SIMPLE_NAMED_PIPE_CLIENT_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPECLIENT_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeClient/ClientConfig.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_CLIENT_CONFIG_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_CLIENT_CONFIG_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPECLIENT_CLIENTCONFIG_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPECLIENT_CLIENTCONFIG_HPP_INCLUDED

/// \file ClientConfig.hpp
/// \brief Configuration for the named pipe client.
Expand Down Expand Up @@ -33,4 +33,4 @@ namespace SimpleNamedPipe {

} // namespace SimpleNamedPipe

#endif // _SIMPLE_NAMED_PIPE_CLIENT_CONFIG_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPECLIENT_CLIENTCONFIG_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeServer.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_SERVER_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_SERVER_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_HPP_INCLUDED

/// \file NamedPipeServer.hpp
/// \brief Server implementation for managing named pipes
Expand Down Expand Up @@ -182,4 +182,4 @@ namespace SimpleNamedPipe {
#include "NamedPipeServer/NamedPipeServer.ipp"
#endif

#endif // _SIMPLE_NAMED_PIPE_SERVER_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeServer/Connection.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_CONNECTION_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_CONNECTION_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_CONNECTION_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_CONNECTION_HPP_INCLUDED

/// \file Connection.hpp
/// \brief Defines the Connection class for managing individual named pipe connections.
Expand Down Expand Up @@ -79,4 +79,4 @@ namespace SimpleNamedPipe {

} // namespace SimpleNamedPipe

#endif // _SIMPLE_NAMED_PIPE_CONNECTION_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_CONNECTION_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeServer/IConnection.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_SERVER_ICONNECTION_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_SERVER_ICONNECTION_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_ICONNECTION_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_ICONNECTION_HPP_INCLUDED

/// \file IConnection.hpp
/// \brief Interface for server-side connection operations.
Expand Down Expand Up @@ -34,4 +34,4 @@ namespace SimpleNamedPipe {

};

#endif // _SIMPLE_NAMED_PIPE_SERVER_ICONNECTION_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_ICONNECTION_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeServer/ServerConfig.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_SERVER_CONFIG_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_SERVER_CONFIG_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVERCONFIG_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVERCONFIG_HPP_INCLUDED

/// \file ServerConfig.hpp
/// \brief Configuration for the named pipe server.
Expand Down Expand Up @@ -36,4 +36,4 @@ namespace SimpleNamedPipe {
};
}

#endif // _SIMPLE_NAMED_PIPE_SERVER_CONFIG_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVERCONFIG_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeServer/ServerEvent.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_SERVER_EVENT_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_SERVER_EVENT_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVEREVENT_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVEREVENT_HPP_INCLUDED

#include <system_error>
#include <string>
Expand Down Expand Up @@ -76,4 +76,4 @@ namespace SimpleNamedPipe {

} // namespace SimpleNamedPipe

#endif // _SIMPLE_NAMED_PIPE_SERVER_EVENT_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVEREVENT_HPP_INCLUDED
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_SERVER_EVENT_HANDLER_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_SERVER_EVENT_HANDLER_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVEREVENTHANDLER_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVEREVENTHANDLER_HPP_INCLUDED

/// \file ServerEventHandler.hpp
/// \brief Base interface for handling server events.
Expand All @@ -23,4 +23,4 @@ namespace SimpleNamedPipe {

}; // namespace SimpleNamedPipe

#endif // _SIMPLE_NAMED_PIPE_SERVER_EVENT_HANDLER_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_SERVEREVENTHANDLER_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/NamedPipeServer/errors.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_SERVER_ERRORS_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_SERVER_ERRORS_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_ERRORS_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_ERRORS_HPP_INCLUDED

/// \file errors.hpp
/// \brief Error codes and category for NamedPipeServer
Expand Down Expand Up @@ -75,4 +75,4 @@ namespace std {
struct is_error_code_enum<SimpleNamedPipe::NamedPipeErrc> : true_type {};
}

#endif // _SIMPLE_NAMED_PIPE_SERVER_ERRORS_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_NAMEDPIPESERVER_ERRORS_HPP_INCLUDED
6 changes: 3 additions & 3 deletions include/SimpleNamedPipe/detail/string_utils.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once
#ifndef _SIMPLE_NAMED_PIPE_DETAIL_STRING_UTILS_HPP_INCLUDED
#define _SIMPLE_NAMED_PIPE_DETAIL_STRING_UTILS_HPP_INCLUDED
#ifndef SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_DETAIL_STRING_UTILS_HPP_INCLUDED
#define SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_DETAIL_STRING_UTILS_HPP_INCLUDED

#include <windows.h>

Expand Down Expand Up @@ -58,4 +58,4 @@ namespace detail {
} // namespace detail
} // namespace SimpleNamedPipe

#endif // _SIMPLE_NAMED_PIPE_DETAIL_STRING_UTILS_HPP_INCLUDED
#endif // SIMPLE_NAMED_PIPE_HEADER_SIMPLENAMEDPIPE_DETAIL_STRING_UTILS_HPP_INCLUDED
Loading