mirror of
https://github.com/RGBCube/serenity
synced 2025-07-28 16:07:45 +00:00
Applications: Move to Userland/Applications/
This commit is contained in:
Andreas Kling
parent
aa939c4b4b
commit
dc28c07fa5
287 changed files with 1 additions and 1 deletions
44
Userland/Applications/Spreadsheet/Writers/CSV.h
Normal file
44
Userland/Applications/Spreadsheet/Writers/CSV.h
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
/*
|
||||
* Copyright (c) 2020, the SerenityOS developers.
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "XSV.h"
|
||||
#include <AK/Forward.h>
|
||||
#include <AK/StringView.h>
|
||||
|
||||
namespace Writer {
|
||||
|
||||
template<typename ContainerType>
|
||||
class CSV : public XSV<ContainerType> {
|
||||
public:
|
||||
CSV(OutputStream& output, const ContainerType& data, const Vector<StringView>& headers = {}, WriterBehaviour behaviours = default_behaviours())
|
||||
: XSV<ContainerType>(output, data, { ",", "\"", WriterTraits::Repeat }, headers, behaviours)
|
||||
{
|
||||
}
|
||||
};
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,96 @@
|
|||
/*
|
||||
* Copyright (c) 2020, the SerenityOS developers.
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#include <AK/TestSuite.h>
|
||||
|
||||
#include "../CSV.h"
|
||||
#include "../XSV.h"
|
||||
#include <AK/MemoryStream.h>
|
||||
|
||||
TEST_CASE(can_write)
|
||||
{
|
||||
Vector<Vector<int>> data = {
|
||||
{ 1, 2, 3 },
|
||||
{ 4, 5, 6 },
|
||||
{ 7, 8, 9 },
|
||||
};
|
||||
|
||||
auto buffer = ByteBuffer::create_uninitialized(1024);
|
||||
OutputMemoryStream stream { buffer };
|
||||
|
||||
Writer::CSV csv(stream, data);
|
||||
|
||||
auto expected_output = R"~(1,2,3
|
||||
4,5,6
|
||||
7,8,9
|
||||
)~";
|
||||
|
||||
EXPECT_EQ(StringView { stream.bytes() }, expected_output);
|
||||
}
|
||||
|
||||
TEST_CASE(can_write_with_header)
|
||||
{
|
||||
Vector<Vector<int>> data = {
|
||||
{ 1, 2, 3 },
|
||||
{ 4, 5, 6 },
|
||||
{ 7, 8, 9 },
|
||||
};
|
||||
|
||||
auto buffer = ByteBuffer::create_uninitialized(1024);
|
||||
OutputMemoryStream stream { buffer };
|
||||
|
||||
Writer::CSV csv(stream, data, { "A", "B\"", "C" });
|
||||
|
||||
auto expected_output = R"~(A,"B""",C
|
||||
1,2,3
|
||||
4,5,6
|
||||
7,8,9
|
||||
)~";
|
||||
|
||||
EXPECT_EQ(StringView { stream.bytes() }, expected_output);
|
||||
}
|
||||
|
||||
TEST_CASE(can_write_with_different_behaviours)
|
||||
{
|
||||
Vector<Vector<String>> data = {
|
||||
{ "Well", "Hello\"", "Friends" },
|
||||
{ "We\"ll", "Hello,", " Friends" },
|
||||
};
|
||||
|
||||
auto buffer = ByteBuffer::create_uninitialized(1024);
|
||||
OutputMemoryStream stream { buffer };
|
||||
|
||||
Writer::CSV csv(stream, data, { "A", "B\"", "C" }, Writer::WriterBehaviour::QuoteOnlyInFieldStart | Writer::WriterBehaviour::WriteHeaders);
|
||||
|
||||
auto expected_output = R"~(A,B",C
|
||||
Well,Hello",Friends
|
||||
We"ll,"Hello,", Friends
|
||||
)~";
|
||||
|
||||
EXPECT_EQ(StringView { stream.bytes() }, expected_output);
|
||||
}
|
||||
|
||||
TEST_MAIN(XSV)
|
||||
215
Userland/Applications/Spreadsheet/Writers/XSV.h
Normal file
215
Userland/Applications/Spreadsheet/Writers/XSV.h
Normal file
|
|
@ -0,0 +1,215 @@
|
|||
/*
|
||||
* Copyright (c) 2020, the SerenityOS developers.
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <AK/GenericLexer.h>
|
||||
#include <AK/OwnPtr.h>
|
||||
#include <AK/Stream.h>
|
||||
#include <AK/String.h>
|
||||
#include <AK/StringView.h>
|
||||
#include <AK/Types.h>
|
||||
#include <AK/Vector.h>
|
||||
|
||||
namespace Writer {
|
||||
|
||||
enum class WriterBehaviour : u32 {
|
||||
None = 0,
|
||||
WriteHeaders = 1,
|
||||
AllowNewlinesInFields = WriteHeaders << 1,
|
||||
QuoteOnlyInFieldStart = WriteHeaders << 2,
|
||||
QuoteAll = WriteHeaders << 3,
|
||||
};
|
||||
|
||||
inline WriterBehaviour operator&(WriterBehaviour left, WriterBehaviour right)
|
||||
{
|
||||
return static_cast<WriterBehaviour>(static_cast<u32>(left) & static_cast<u32>(right));
|
||||
}
|
||||
|
||||
inline WriterBehaviour operator|(WriterBehaviour left, WriterBehaviour right)
|
||||
{
|
||||
return static_cast<WriterBehaviour>(static_cast<u32>(left) | static_cast<u32>(right));
|
||||
}
|
||||
|
||||
struct WriterTraits {
|
||||
String separator;
|
||||
String quote { "\"" };
|
||||
enum {
|
||||
Repeat,
|
||||
Backslash,
|
||||
} quote_escape { Repeat };
|
||||
};
|
||||
|
||||
#define ENUMERATE_WRITE_ERRORS() \
|
||||
E(None, "No errors") \
|
||||
E(NonConformingColumnCount, "Header count does not match given column count") \
|
||||
E(InternalError, "Internal error")
|
||||
|
||||
enum class WriteError {
|
||||
#define E(name, _) name,
|
||||
ENUMERATE_WRITE_ERRORS()
|
||||
#undef E
|
||||
};
|
||||
|
||||
inline constexpr WriterBehaviour default_behaviours()
|
||||
{
|
||||
return WriterBehaviour::None;
|
||||
}
|
||||
|
||||
template<typename ContainerType>
|
||||
class XSV {
|
||||
public:
|
||||
XSV(OutputStream& output, const ContainerType& data, const WriterTraits& traits, const Vector<StringView>& headers = {}, WriterBehaviour behaviours = default_behaviours())
|
||||
: m_data(data)
|
||||
, m_traits(traits)
|
||||
, m_behaviours(behaviours)
|
||||
, m_names(headers)
|
||||
, m_output(output)
|
||||
{
|
||||
if (!headers.is_empty())
|
||||
m_behaviours = m_behaviours | WriterBehaviour::WriteHeaders;
|
||||
|
||||
generate();
|
||||
}
|
||||
|
||||
virtual ~XSV() { }
|
||||
|
||||
bool has_error() const { return m_error != WriteError::None; }
|
||||
WriteError error() const { return m_error; }
|
||||
String error_string() const
|
||||
{
|
||||
switch (m_error) {
|
||||
#define E(x, y) \
|
||||
case WriteError::x: \
|
||||
return y;
|
||||
|
||||
ENUMERATE_WRITE_ERRORS();
|
||||
#undef E
|
||||
}
|
||||
ASSERT_NOT_REACHED();
|
||||
}
|
||||
|
||||
private:
|
||||
void set_error(WriteError error)
|
||||
{
|
||||
if (m_error == WriteError::None)
|
||||
m_error = error;
|
||||
}
|
||||
|
||||
void generate()
|
||||
{
|
||||
auto with_headers = (m_behaviours & WriterBehaviour::WriteHeaders) != WriterBehaviour::None;
|
||||
if (with_headers) {
|
||||
write_row(m_names);
|
||||
if (m_output.write({ "\n", 1 }) != 1)
|
||||
set_error(WriteError::InternalError);
|
||||
}
|
||||
|
||||
for (auto&& row : m_data) {
|
||||
if (with_headers) {
|
||||
if (row.size() != m_names.size())
|
||||
set_error(WriteError::NonConformingColumnCount);
|
||||
}
|
||||
|
||||
write_row(row);
|
||||
if (m_output.write({ "\n", 1 }) != 1)
|
||||
set_error(WriteError::InternalError);
|
||||
}
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
void write_row(T&& row)
|
||||
{
|
||||
bool first = true;
|
||||
for (auto&& entry : row) {
|
||||
if (!first) {
|
||||
if (m_output.write(m_traits.separator.bytes()) != m_traits.separator.length())
|
||||
set_error(WriteError::InternalError);
|
||||
}
|
||||
first = false;
|
||||
write_entry(entry);
|
||||
}
|
||||
}
|
||||
|
||||
template<typename T>
|
||||
void write_entry(T&& entry)
|
||||
{
|
||||
auto string = String::formatted("{}", FormatIfSupported(entry));
|
||||
|
||||
auto safe_to_write_normally = !string.contains("\n") && !string.contains(m_traits.separator);
|
||||
if (safe_to_write_normally) {
|
||||
if ((m_behaviours & WriterBehaviour::QuoteOnlyInFieldStart) == WriterBehaviour::None)
|
||||
safe_to_write_normally = !string.contains(m_traits.quote);
|
||||
else
|
||||
safe_to_write_normally = !string.starts_with(m_traits.quote);
|
||||
}
|
||||
if (safe_to_write_normally) {
|
||||
if (m_output.write(string.bytes()) != string.length())
|
||||
set_error(WriteError::InternalError);
|
||||
return;
|
||||
}
|
||||
|
||||
if (m_output.write(m_traits.quote.bytes()) != m_traits.quote.length())
|
||||
set_error(WriteError::InternalError);
|
||||
|
||||
GenericLexer lexer(string);
|
||||
while (!lexer.is_eof()) {
|
||||
if (lexer.consume_specific(m_traits.quote)) {
|
||||
switch (m_traits.quote_escape) {
|
||||
case WriterTraits::Repeat:
|
||||
if (m_output.write(m_traits.quote.bytes()) != m_traits.quote.length())
|
||||
set_error(WriteError::InternalError);
|
||||
if (m_output.write(m_traits.quote.bytes()) != m_traits.quote.length())
|
||||
set_error(WriteError::InternalError);
|
||||
break;
|
||||
case WriterTraits::Backslash:
|
||||
if (m_output.write({ "\\", 1 }) != 1)
|
||||
set_error(WriteError::InternalError);
|
||||
if (m_output.write(m_traits.quote.bytes()) != m_traits.quote.length())
|
||||
set_error(WriteError::InternalError);
|
||||
break;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
auto ch = lexer.consume();
|
||||
if (m_output.write({ &ch, 1 }) != 1)
|
||||
set_error(WriteError::InternalError);
|
||||
}
|
||||
|
||||
if (m_output.write(m_traits.quote.bytes()) != m_traits.quote.length())
|
||||
set_error(WriteError::InternalError);
|
||||
}
|
||||
|
||||
const ContainerType& m_data;
|
||||
const WriterTraits& m_traits;
|
||||
WriterBehaviour m_behaviours;
|
||||
const Vector<StringView>& m_names;
|
||||
WriteError m_error { WriteError::None };
|
||||
OutputStream& m_output;
|
||||
};
|
||||
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue