platypus/README.md

# PLATYPUS
*Buffer Descriptor for the PLATYPUS language specification*

## Building

### In macOS/Linux
#### Requires
*gcc (tested in version 6.3.x) or clang (tested under LLVM clang-0800.0.42.1)*

- `make [gcc | clang]`
    - Default is to build both versions (this is an aftermath of testing behaviour from different compilers)
    - It is safe to modify the default to either gcc or clang if you don't have one of them
- **NOTE: I haven't tested or created make targets for the scanner yet.**
### Windows
#### Requires
- `msvc` (tested under Visual Studio 2015 with Update 3, however VS2013 shouldn't behave abnormally either, nor should 2017)
- Disable language extensions (use ANSI C)
---
## Running
### Running the Buffer only
- *macOS/linux*
    - `$ ./buffer_<compiler> <file> [f | a | m] > <out_file>`
- *Windows*
    - `$ buffer <file> f | a | m] > <out_file>`

### Usage
- F: fixed capacity mode. Buffe will not auto-resize if not enough space for the file
- A: additive mode: Buffer will resize in a linear increment.
- M: multiplicative mode: Buffer will resize based on a pre-set multiplier based on remaining allowed memory space (`$SHRT_MAX bytes`)


# Notes

This is in no way complete, it is missing a scanner implementation, parser, symbol table, etc.

You can modify the initial capacity and increment factor defined in `platy_bt.c` (should really make that a command line parameter in a future release)
- Increment factor range for additive mode: `1 - 255`. (setting this to 0 implies fixed mode, regardless of the mode given in the command line)
- Initial capacity range (in bytes): `0 - 32767 (SHRT_MAX)`
- This is due to my environment's install locations for the C include libraries: 
    - **Inside `buffer.h`, there is a `#DEFINE` line for `MACOS_DEP`. If you are using a Linux system or Windows and your malloc.h is actually named malloc.h, you can leave `#undef MACOS_DEP` alone, otherwise comment it out.**
Bulk commit Test files: add original test files (small and "buffer-braking" files to check buffer behaviour Add README 2017-02-02 21:44:26 +00:00			`# PLATYPUS`
			`Buffer Descriptor for the PLATYPUS language specification`

			`## Building`

			`### In macOS/Linux`
			`#### Requires`
			`gcc (tested in version 6.3.x) or clang (tested under LLVM clang-0800.0.42.1)`

			- `make [gcc \| clang]`
			`- Default is to build both versions (this is an aftermath of testing behaviour from different compilers)`
			`- It is safe to modify the default to either gcc or clang if you don't have one of them`
Update README 2017-03-18 22:13:58 +00:00			`- NOTE: I haven't tested or created make targets for the scanner yet.`
Bulk commit Test files: add original test files (small and "buffer-braking" files to check buffer behaviour Add README 2017-02-02 21:44:26 +00:00			`### Windows`
			`#### Requires`
Update README 2017-03-18 22:13:58 +00:00			- `msvc` (tested under Visual Studio 2015 with Update 3, however VS2013 shouldn't behave abnormally either, nor should 2017)
Bulk commit Test files: add original test files (small and "buffer-braking" files to check buffer behaviour Add README 2017-02-02 21:44:26 +00:00			`- Disable language extensions (use ANSI C)`
			`---`
			`## Running`
Update README 2017-03-18 22:13:58 +00:00			`### Running the Buffer only`
Bulk commit Test files: add original test files (small and "buffer-braking" files to check buffer behaviour Add README 2017-02-02 21:44:26 +00:00			`- macOS/linux`
			- `$ ./buffer_<compiler> <file> [f \| a \| m] > <out_file>`
			`- Windows`
			- `$ buffer <file> f \| a \| m] > <out_file>`

			`### Usage`
			`- F: fixed capacity mode. Buffe will not auto-resize if not enough space for the file`
			`- A: additive mode: Buffer will resize in a linear increment.`
			- M: multiplicative mode: Buffer will resize based on a pre-set multiplier based on remaining allowed memory space (`$SHRT_MAX bytes`)


			`# Notes`

			`This is in no way complete, it is missing a scanner implementation, parser, symbol table, etc.`

			You can modify the initial capacity and increment factor defined in `platy_bt.c` (should really make that a command line parameter in a future release)
			- Increment factor range for additive mode: `1 - 255`. (setting this to 0 implies fixed mode, regardless of the mode given in the command line)
			- Initial capacity range (in bytes): `0 - 32767 (SHRT_MAX)`
			`- This is due to my environment's install locations for the C include libraries:`
Update README 2017-03-18 22:13:58 +00:00			- Inside `buffer.h`, there is a `#DEFINE` line for `MACOS_DEP`. If you are using a Linux system or Windows and your malloc.h is actually named malloc.h, you can leave `#undef MACOS_DEP` alone, otherwise comment it out.