crashpad/util/file/delimited_file_reader.h
Peter Boström 1aa478d161 Remove DISALLOW_* macros in crashpad
This change was partially scripted and partially done manually with vim
regex + manually placing the deleted constructors.

The script change looked for destructors in the public: section of a
class, if that existed the deleted constructors would go before the
destructor.

For manual placement I looked for any constructor in the public: section
of the corresponding class. If there wasn't one, then it would ideally
have gone as the first entry except below enums, classes and typedefs.
This may not have been perfect, but is hopefully good enough. Fingers
crossed.

#include "base/macros.h" is removed from files that don't use
ignore_result, which is the only other thing defined in base/macros.h.

Bug: chromium:1010217
Change-Id: I099526255a40b1ac1264904b4ece2f3f503c9418
Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/3171034
Reviewed-by: Mark Mentovai <mark@chromium.org>
Commit-Queue: Peter Boström <pbos@chromium.org>
2021-09-21 15:09:44 +00:00

95 lines
3.4 KiB
C++
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Copyright 2017 The Crashpad Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef CRASHPAD_UTIL_FILE_DELIMITED_FILE_READER_H_
#define CRASHPAD_UTIL_FILE_DELIMITED_FILE_READER_H_
#include <stdint.h>
#include <string>
#include "util/file/file_reader.h"
namespace crashpad {
//! \brief Reads a file one field or line at a time.
//!
//! The file is interpreted as a series of fields separated by delimiter
//! characters. When the delimiter character is the newline character
//! (<code>'\\n'</code>), the file is interpreted as a series of lines.
//!
//! It is safe to mix GetDelim() and GetLine() calls, if appropriate for the
//! format being interpreted.
//!
//! This is a replacement for the standard librarys `getdelim()` and
//! `getline()` functions, adapted to work with FileReaderInterface objects
//! instead of `FILE*` streams.
class DelimitedFileReader {
public:
//! \brief The result of a GetDelim() or GetLine() call.
enum class Result {
//! \brief An error occurred, and a message was logged.
kError = -1,
//! \brief A field or line was read from the file.
kSuccess,
//! \brief The end of the file was encountered.
kEndOfFile,
};
explicit DelimitedFileReader(FileReaderInterface* file_reader);
DelimitedFileReader(const DelimitedFileReader&) = delete;
DelimitedFileReader& operator=(const DelimitedFileReader&) = delete;
~DelimitedFileReader();
//! \brief Reads a single field from the file.
//!
//! \param[in] delimiter The delimiter character that terminates the field.
//! It is safe to call this method multiple times while changing the value
//! of this parameter, if appropriate for the format being interpreted.
//! \param[out] field The field read from the file. This parameter will
//! include the fields terminating delimiter character unless the field
//! was at the end of the file and was read without such a character.
//! This parameter will not be empty.
//!
//! \return a #Result value. \a field is only valid when Result::kSuccess is
//! returned.
Result GetDelim(char delimiter, std::string* field);
//! \brief Reads a single line from the file.
//!
//! \param[out] line The line read from the file. This parameter will include
//! the line terminating delimiter character unless the line was at the
//! end of the file and was read without such a character. This parameter
//! will not be empty.
//!
//! \return a #Result value. \a line is only valid when Result::kSuccess is
//! returned.
Result GetLine(std::string* line);
private:
char buf_[4096];
FileReaderInterface* file_reader_; // weak
uint16_t buf_pos_; // Index into buf_ of the start of the next field.
uint16_t buf_len_; // The size of buf_ thats been filled.
bool eof_; // Caches the EOF signal when detected following a partial field.
};
} // namespace crashpad
#endif // CRASHPAD_UTIL_FILE_DELIMITED_FILE_READER_H_