WindTerm/src/README.md

**All source codes (except thirdparty directory) are provided under the terms of Apache-2.0 license.**

# Components

Below is a list of (some) WindTerm components in alphabetical order, along with a brief description of each.

## CircularBuffer.h

A quick circular buffer template class.

## Cryptographic.h/cpp

A very safe encryption class using the PBKDF2-algorithm as defined in RFC 8018. WindTerm uses this class together with the user's master password to protect user data, including passwords, private keys and so on.

## Onigmo

An improved version based on Onigmo 5.13.5. In particular, **the addition of iterator makes it possible to match gap buffer or nonadjacent memory blocks.** Please refer to the sample files for how to use.

## ScopeGuard.h

A class of which the sole purpose is to run the function f in its destructor. This is useful for guaranteeing your cleanup code is executed.

## Spin.h

A high-performance spin mutex and locker.
Update license 2020-07-17 12:28:59 +08:00			`All source codes (except thirdparty directory) are provided under the terms of Apache-2.0 license.`

Add iterator to search gap buffer and wildcard matching, whole word matching. 2020-07-17 02:57:05 +08:00			`# Components`

			`Below is a list of (some) WindTerm components in alphabetical order, along with a brief description of each.`

Add a quick circular buffer class. 2020-07-28 01:38:01 +08:00			`## CircularBuffer.h`

			`A quick circular buffer template class.`

Add a safe encryption class. 2020-07-28 02:05:46 +08:00			`## Cryptographic.h/cpp`

			`A very safe encryption class using the PBKDF2-algorithm as defined in RFC 8018. WindTerm uses this class together with the user's master password to protect user data, including passwords, private keys and so on.`

Add iterator to search gap buffer and wildcard matching, whole word matching. 2020-07-17 02:57:05 +08:00			`## Onigmo`

Add a high-performance spin mutex class. 2020-07-28 01:43:10 +08:00			`An improved version based on Onigmo 5.13.5. In particular, the addition of iterator makes it possible to match gap buffer or nonadjacent memory blocks. Please refer to the sample files for how to use.`

Add a scope guard template class. 2020-07-28 01:47:29 +08:00			`## ScopeGuard.h`

			`A class of which the sole purpose is to run the function f in its destructor. This is useful for guaranteeing your cleanup code is executed.`

Add a high-performance spin mutex class. 2020-07-28 01:43:10 +08:00			`## Spin.h`

			`A high-performance spin mutex and locker.`