summaryrefslogtreecommitdiff
path: root/src/io.h
diff options
context:
space:
mode:
authorjakob <jakob@memeware.net>2017-02-13 16:53:11 -0500
committerjakob <jakob@memeware.net>2017-02-13 16:53:11 -0500
commit01d185f31ff7194773342881fa0e0a550b5d5c5a (patch)
treee708be1001500e0932f77f82483e6c90a3e4e24d /src/io.h
parent3b9772a65146afb36e29b5bce082ce5aa1483c22 (diff)
Began inevetable rewrite.
Diffstat (limited to 'src/io.h')
-rw-r--r--src/io.h57
1 files changed, 57 insertions, 0 deletions
diff --git a/src/io.h b/src/io.h
new file mode 100644
index 0000000..f07a421
--- /dev/null
+++ b/src/io.h
@@ -0,0 +1,57 @@
+/* io.h -- Code for file and memory I/O.
+
+ Copyright (C) 2017 Jakob Tsar-Fox, All Rights Reserved.
+
+ This file is part of Nekopack.
+
+ Nekopack is free software: you can redistribute it and/or modify it
+ under the terms of the GNU General Public License as published by the
+ Free Software Foundation, either version 3 of the License, or (at
+ your option) any later version.
+
+ Nekopack is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Nekopack. If not, see <http://www.gnu.org/licenses/>. */
+
+#pragma once
+
+#include <stdbool.h>
+#include <stddef.h>
+
+/* Internal enumerable type for representing the location of a memory
+ segment. Used for freeing and unmapping purposes, if necessary. */
+enum _location {
+ HEAP,
+}
+
+/* Structure to emulate a stream of data that maintains a current
+ position. The structure additionally maintains a `length` variable
+ containing the stream's length. */
+struct stream {
+ size_t len; /* Length of the stream. */
+ void *_start; /* Pointer to the stream's start. */
+ void *_cur; /* Pointer to the current position. */
+ enum _location _loc; /* Location of the stream in memory. */
+}
+
+/* Allocates `len` bytes of memory and returns a new stream pointing to
+ it. The memory provided has not zeroed. */
+struct stream *stream_new(size_t len);
+
+/* Called to free or unmap the memory chunk associated with the given
+ stream, as well as the stream structure itself. */
+void stream_free(struct stream *s);
+
+
+/* Copies `n` bytes from the given stream into the memory area specified
+ by `dest`. The stream is advanced appropriately. */
+void stream_read(void *dest, struct stream *s, size_t n);
+
+
+/* Copies `n` bytes into the given stream from the memory area specified
+ by `src`. The stream is advanced appropriately. */
+void stream_write(struct stream *s, void *src, size_t n);