Skip to content

Commit 2c8ca2e

Browse files
laparcalaparca
committed
Start README and refactor
1 parent 1ea9cc3 commit 2c8ca2e

File tree

5 files changed

+206
-12
lines changed

5 files changed

+206
-12
lines changed

‎CMakeLists.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ project(lzc-coro VERSION 0.1.0
44
HOMEPAGE_URL "https://github.com/lazy-coders/lzc-coro"
55
LANGUAGES CXX)
66

7-
#set(CMAKE_CXX_STANDARD 23)
8-
#set(CMAKE_CXX_STANDARD_REQUIRED ON)
9-
107
include(cmake/CPM.cmake)
118

12-
add_library(lzc-coro INTERFACE)
9+
add_library(lzc-coro)
10+
target_compile_features(lzc-coro PUBLIC cxx_std_23)
11+
target_sources(lzc-coro PRIVATE src/lzcoders/default_execution_context.cpp)
12+
target_include_directories(lzc-coro PUBLIC include)
13+
target_compile_options(lzc-coro PUBLIC "-fcoroutines")
1314
target_include_directories(
1415
lzc-coro
1516
INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
1617
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
1718

18-
target_compile_features(lzc-coro INTERFACE cxx_std_23)
1919

2020

2121
include(GNUInstallDirs)

‎CONTRIBUTING.md

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
<!-- omit in toc -->
2+
# Contributing to lzc-coro
3+
4+
First off, thanks for taking the time to contribute! ❤️
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
7+
8+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9+
> - Star the project
10+
> - Tweet about it
11+
> - Refer this project in your project's readme
12+
> - Mention the project at local meetups and tell your friends/colleagues
13+
14+
<!-- omit in toc -->
15+
## Table of Contents
16+
17+
- [Code of Conduct](#code-of-conduct)
18+
- [I Have a Question](#i-have-a-question)
19+
- [I Want To Contribute](#i-want-to-contribute)
20+
- [Reporting Bugs](#reporting-bugs)
21+
- [Suggesting Enhancements](#suggesting-enhancements)
22+
- [Your First Code Contribution](#your-first-code-contribution)
23+
- [Improving The Documentation](#improving-the-documentation)
24+
- [Styleguides](#styleguides)
25+
- [Commit Messages](#commit-messages)
26+
- [Join The Project Team](#join-the-project-team)
27+
28+
29+
## Code of Conduct
30+
31+
This project and everyone participating in it is governed by the
32+
[lzc-coro Code of Conduct](https://github.com/lazy-coders/lzc-coroblob/master/CODE_OF_CONDUCT.md).
33+
By participating, you are expected to uphold this code. Please report unacceptable behavior
34+
to .
35+
36+
37+
## I Have a Question
38+
39+
> If you want to ask a question, we assume that you have read the available [Documentation]().
40+
41+
Before you ask a question, it is best to search for existing [Issues](https://github.com/lazy-coders/lzc-coro/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
42+
43+
If you then still feel the need to ask a question and need clarification, we recommend the following:
44+
45+
- Open an [Issue](https://github.com/lazy-coders/lzc-coro/issues/new).
46+
- Provide as much context as you can about what you're running into.
47+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
48+
49+
We will then take care of the issue as soon as possible.
50+
51+
<!--
52+
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
53+
54+
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
55+
- IRC
56+
- Slack
57+
- Gitter
58+
- Stack Overflow tag
59+
- Blog
60+
- FAQ
61+
- Roadmap
62+
- E-Mail List
63+
- Forum
64+
-->
65+
66+
## I Want To Contribute
67+
68+
> ### Legal Notice <!-- omit in toc -->
69+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
70+
71+
### Reporting Bugs
72+
73+
<!-- omit in toc -->
74+
#### Before Submitting a Bug Report
75+
76+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
77+
78+
- Make sure that you are using the latest version.
79+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
80+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/lazy-coders/lzc-coroissues?q=label%3Abug).
81+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
82+
- Collect information about the bug:
83+
- Stack trace (Traceback)
84+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
85+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
86+
- Possibly your input and the output
87+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
88+
89+
<!-- omit in toc -->
90+
#### How Do I Submit a Good Bug Report?
91+
92+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to .
93+
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
94+
95+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
96+
97+
- Open an [Issue](https://github.com/lazy-coders/lzc-coro/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
98+
- Explain the behavior you would expect and the actual behavior.
99+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
100+
- Provide the information you collected in the previous section.
101+
102+
Once it's filed:
103+
104+
- The project team will label the issue accordingly.
105+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
106+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
107+
108+
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
109+
110+
111+
### Suggesting Enhancements
112+
113+
This section guides you through submitting an enhancement suggestion for lzc-coro, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
114+
115+
<!-- omit in toc -->
116+
#### Before Submitting an Enhancement
117+
118+
- Make sure that you are using the latest version.
119+
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
120+
- Perform a [search](https://github.com/lazy-coders/lzc-coro/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
121+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
122+
123+
<!-- omit in toc -->
124+
#### How Do I Submit a Good Enhancement Suggestion?
125+
126+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/lazy-coders/lzc-coro/issues).
127+
128+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
129+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
130+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
131+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
132+
- **Explain why this enhancement would be useful** to most lzc-coro users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
133+
134+
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
135+
136+
### Your First Code Contribution
137+
<!-- TODO
138+
include Setup of env, IDE and typical getting started instructions?
139+
140+
-->
141+
142+
### Improving The Documentation
143+
<!-- TODO
144+
Updating, improving and correcting the documentation
145+
146+
-->
147+
148+
## Styleguides
149+
### Commit Messages
150+
<!-- TODO
151+
152+
-->
153+
154+
## Join The Project Team
155+
<!-- TODO -->
156+
157+
<!-- omit in toc -->
158+
## Attribution
159+
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

‎README.md

+32-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11
[![codecov](https://codecov.io/gh/lazy-coders/lzc-coro/graph/badge.svg?token=O1N5INRR9G)](https://codecov.io/gh/lazy-coders/lzc-coro) [![CMake on Ubuntu with G++-13](https://github.com/lazy-coders/lzc-coro/actions/workflows/cmake-ubuntu-g++13.yml/badge.svg)](https://github.com/lazy-coders/lzc-coro/actions/workflows/cmake-ubuntu-g++13.yml)
22

3-
# LaZyCoders COROutine library
3+
# lzc-coro - LaZyCoders COROutine library
44

5-
WIP: at this momento the repository is in maintenance mode.
5+
This small library have the objective of understand coroutine facility. It is
6+
too a playground to test some ideas about how coroutines could work.
7+
8+
# The basics
9+
10+
This library only implements the `task`: a coroutine that can do `co_await`.
11+
12+
All `tasks` can be awaitable and are created stopped. That means a coroutine do
13+
not start executing code until the call to `operator()` of the `task` is called.
14+
15+
```mermaid
16+
sequenceDiagram
17+
box Main Thread
18+
participant main
19+
participant some_task
20+
participant other_task
21+
end
22+
box Other Thread
23+
participant async_function
24+
end
25+
26+
main->>some_task: operator()
27+
someTask->>other_task: co_await
28+
other_task->>async_function: co_await
29+
30+
Note over other_task,async_function: The coroutine wait until completion<br/>and continues in the original thread
31+
32+
async_function-->>other_task
33+
other_task-->some_task
34+
some_task-->main
35+
```

‎include/lzcoders/coro.hpp

+1-5
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,7 @@ struct coro_execution_context
1717

1818
struct default_execution_context : coro_execution_context
1919
{
20-
void resume(std::coroutine_handle<> h) override
21-
{
22-
d();
23-
h.resume();
24-
}
20+
void resume(std::coroutine_handle<> h) override;
2521
};
2622

2723
template<typename T>

‎src/lzcoders/default_execution_context.cpp

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#include <coroutine>
2+
#include <lzcoders/coro.hpp>
3+
#include <lzcoders/debug.hpp>
4+
5+
void lzcoders::default_execution_context::resume(std::coroutine_handle<> h)
6+
{
7+
d();
8+
h.resume();
9+
}

0 commit comments

Comments
 (0)