vsg: include/vsg/io/txt.h Source File

vsg 1.1.13 VulkanSceneGraph library

Loading...
Searching...
No Matches
txt.h
1#pragma once
2
3/* <editor-fold desc="MIT License">
4
5Copyright(c) 2023 Robert Osfield
6
7Permission is hereby granted, free of charge, to any person obtaining a copy of
8this software and associated documentation files (the "Software"), to deal in
9the Software without restriction, including without limitation the rights to
10use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11the Software, and to permit persons to whom the Software is furnished to do so,
12subject to the following conditions:
13
14The above copyright notice and this permission notice shall be included in all
15copies or substantial portions of the Software.
16
17THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
24</editor-fold> */
25
26#include <vsg/io/ReaderWriter.h>
27
28#include <set>
29
30namespace vsg
31{
32
34 class VSG_DECLSPEC txt : public Inherit<ReaderWriter, txt>
35 {
36 public:
37 txt();
38
39 ref_ptr<Object> read(const Path& filename, ref_ptr<const Options> options = {}) const override;
40 ref_ptr<Object> read(std::istream& fin, ref_ptr<const Options> options = {}) const override;
41 ref_ptr<Object> read(const uint8_t* ptr, size_t size, ref_ptr<const Options> = {}) const override;
42
43 bool getFeatures(Features& features) const override;
44
46 std::set<vsg::Path> supportedExtensions;
47
49 static bool extensionSupported(const vsg::Path& path);
50
51 protected:
52 ref_ptr<Object> _read(std::istream& fin, ref_ptr<const Options> options = {}) const;
53 };
54 VSG_type_name(vsg::txt);
55
56} // namespace vsg
vsg::Path
Definition Path.h:34
vsg::ref_ptr
Definition ref_ptr.h:22
vsg::txt
ReaderWriter for reading and writing text files of different types such as .txt, ,...
Definition txt.h:35
vsg::txt::getFeatures
bool getFeatures(Features &features) const override
get the Features supported by this ReaderWriter
vsg::txt::read
ref_ptr< Object > read(const uint8_t *ptr, size_t size, ref_ptr< const Options >={}) const override
read object from memory block, return object on success, return null ref_ptr<> if format not supporte...
vsg::txt::read
ref_ptr< Object > read(std::istream &fin, ref_ptr< const Options > options={}) const override
read object from input stream, return object on success, return null ref_ptr<> if format not supporte...
vsg::txt::supportedExtensions
std::set< vsg::Path > supportedExtensions
supported extensions, users may add/remove entries to customize which types of files can be read as a...
Definition txt.h:46
vsg::txt::read
ref_ptr< Object > read(const Path &filename, ref_ptr< const Options > options={}) const override
read object from file, return object on success, return null ref_ptr<> if format not supported,...
vsg::txt::extensionSupported
static bool extensionSupported(const vsg::Path &path)
built-in supported extensions
vsg::ReaderWriter::Features
Definition ReaderWriter.h:92