diff options
Diffstat (limited to 'include/qpdf/InputSource.hh')
| -rw-r--r-- | include/qpdf/InputSource.hh | 49 |
1 files changed, 20 insertions, 29 deletions
diff --git a/include/qpdf/InputSource.hh b/include/qpdf/InputSource.hh index 91a5c6e5..2bc57c57 100644 --- a/include/qpdf/InputSource.hh +++ b/include/qpdf/InputSource.hh @@ -2,22 +2,19 @@ // // This file is part of qpdf. // -// 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 +// 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. +// 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. // -// Versions of qpdf prior to version 7 were released under the terms -// of version 2.0 of the Artistic License. At your option, you may -// continue to consider qpdf to be licensed under those terms. Please -// see the manual for additional information. +// Versions of qpdf prior to version 7 were released under the terms of version 2.0 of the Artistic +// License. At your option, you may continue to consider qpdf to be licensed under those terms. +// Please see the manual for additional information. #ifndef QPDF_INPUTSOURCE_HH #define QPDF_INPUTSOURCE_HH @@ -30,9 +27,8 @@ #include <memory> #include <string> -// Remember to use QPDF_DLL_CLASS on anything derived from InputSource -// so it will work with dynamic_cast across the shared object -// boundary. +// Remember to use QPDF_DLL_CLASS on anything derived from InputSource so it will work with +// dynamic_cast across the shared object boundary. class QPDF_DLL_CLASS InputSource { public: @@ -61,12 +57,10 @@ class QPDF_DLL_CLASS InputSource QPDF_DLL std::string readLine(size_t max_line_length); - // Find first or last occurrence of a sequence of characters - // starting within the range defined by offset and len such that, - // when the input source is positioned at the beginning of that - // sequence, finder.check() returns true. If len is 0, the search - // proceeds until EOF. If a qualifying pattern is found, these - // methods return true and leave the input source positioned + // Find first or last occurrence of a sequence of characters starting within the range defined + // by offset and len such that, when the input source is positioned at the beginning of that + // sequence, finder.check() returns true. If len is 0, the search proceeds until EOF. If a + // qualifying pattern is found, these methods return true and leave the input source positioned // wherever check() left it at the end of the matching pattern. QPDF_DLL bool findFirst(char const* start_chars, qpdf_offset_t offset, size_t len, Finder& finder); @@ -80,11 +74,9 @@ class QPDF_DLL_CLASS InputSource virtual void rewind() = 0; virtual size_t read(char* buffer, size_t length) = 0; - // Note: you can only unread the character you just read. The - // specific character is ignored by some implementations, and the - // implementation doesn't check this. Use of unreadCh is - // semantically equivalent to seek(-1, SEEK_CUR) but is much more - // efficient. + // Note: you can only unread the character you just read. The specific character is ignored by + // some implementations, and the implementation doesn't check this. Use of unreadCh is + // semantically equivalent to seek(-1, SEEK_CUR) but is much more efficient. virtual void unreadCh(char ch) = 0; // The following methods are for use by QPDFTokenizer @@ -149,9 +141,8 @@ InputSource::fastTell() inline bool InputSource::fastRead(char& ch) { - // Before calling fastRead, fastTell must be called to prepare the buffer. - // Once reading is complete, fastUnread must be called to set the correct - // file position. + // Before calling fastRead, fastTell must be called to prepare the buffer. Once reading is + // complete, fastUnread must be called to set the correct file position. if (this->buf_idx < this->buf_len) { ch = this->buffer[this->buf_idx]; ++(this->buf_idx); |