kakoune

Fork of kakoune, an acceptable text editor
git clone git://git.laack.co/kakoune.git
Log | Files | Refs

buffer_utils.hh (3489B)


      1 #ifndef buffer_utils_hh_INCLUDED
      2 #define buffer_utils_hh_INCLUDED
      3 
      4 #include "buffer.hh"
      5 #include "selection.hh"
      6 
      7 #include "utf8_iterator.hh"
      8 #include "unicode.hh"
      9 
     10 namespace Kakoune
     11 {
     12 
     13 inline String content(const Buffer& buffer, const Selection& range)
     14 {
     15     return buffer.string(range.min(), buffer.char_next(range.max()));
     16 }
     17 
     18 inline BufferCoord erase(Buffer& buffer, const Selection& range)
     19 {
     20     return buffer.erase(range.min(), buffer.char_next(range.max()));
     21 }
     22 
     23 void replace(Buffer& buffer, ArrayView<BufferRange> ranges, ConstArrayView<String> strings);
     24 
     25 inline CharCount char_length(const Buffer& buffer, const Selection& range)
     26 {
     27     return utf8::distance(buffer.iterator_at(range.min()),
     28                           buffer.iterator_at(buffer.char_next(range.max())));
     29 }
     30 
     31 inline CharCount char_length(const Buffer& buffer, const BufferCoord& begin, const BufferCoord& end)
     32 {
     33     return utf8::distance(buffer.iterator_at(begin), buffer.iterator_at(end));
     34 }
     35 
     36 inline ColumnCount column_length(const Buffer& buffer, const BufferCoord& begin, const BufferCoord& end)
     37 {
     38     return utf8::column_distance(buffer.iterator_at(begin), buffer.iterator_at(end));
     39 }
     40 
     41 inline bool is_bol(BufferCoord coord)
     42 {
     43     return coord.column == 0;
     44 }
     45 
     46 inline bool is_eol(const Buffer& buffer, BufferCoord coord)
     47 {
     48     return buffer.is_end(coord) or buffer[coord.line].length() == coord.column+1;
     49 }
     50 
     51 inline bool is_bow(const Buffer& buffer, BufferCoord coord)
     52 {
     53     auto it = utf8::iterator<BufferIterator>(buffer.iterator_at(coord), buffer);
     54     if (coord == BufferCoord{0,0})
     55         return is_word(*it);
     56 
     57     return not is_word(*(it-1)) and is_word(*it);
     58 }
     59 
     60 inline bool is_eow(const Buffer& buffer, BufferCoord coord)
     61 {
     62     if (buffer.is_end(coord) or coord == BufferCoord{0,0})
     63         return false;
     64 
     65     auto it = utf8::iterator<BufferIterator>(buffer.iterator_at(coord), buffer);
     66     return is_word(*(it-1)) and not is_word(*it);
     67 }
     68 
     69 ColumnCount get_column(const Buffer& buffer, ColumnCount tabstop, BufferCoord coord);
     70 ColumnCount column_length(const Buffer& buffer, ColumnCount tabstop, LineCount line);
     71 
     72 ByteCount get_byte_to_column(const Buffer& buffer, ColumnCount tabstop,
     73                              DisplayCoord coord);
     74 
     75 enum class AutoScroll { No, NotInitially, Yes };
     76 Buffer* create_fifo_buffer(String name, int fd, Buffer::Flags flags, AutoScroll scroll);
     77 Buffer* create_buffer_from_string(String name, Buffer::Flags flags, StringView data);
     78 Buffer* open_file_buffer(StringView filename,
     79                          Buffer::Flags flags = Buffer::Flags::None);
     80 Buffer* open_or_create_file_buffer(StringView filename,
     81                                    Buffer::Flags flags = Buffer::Flags::None);
     82 void reload_file_buffer(Buffer& buffer);
     83 
     84 enum class WriteFlags
     85 {
     86     None  = 0,
     87     Force = 0b01,
     88     Sync  = 0b10
     89 };
     90 constexpr bool with_bit_ops(Meta::Type<WriteFlags>) { return true; }
     91 
     92 void write_buffer_to_file(Buffer& buffer, StringView filename,
     93                           WriteMethod method, WriteFlags flags,
     94                           Optional<FinalEol> finaleol = {});
     95 void write_buffer_to_fd(Buffer& buffer, int fd, Optional<FinalEol> finaleol = {});
     96 void write_buffer_to_backup_file(Buffer& buffer);
     97 
     98 
     99 void write_to_debug_buffer(StringView str);
    100 
    101 Vector<String> history_as_strings(ConstArrayView<Buffer::HistoryNode> history);
    102 Vector<String> undo_group_as_strings(const Buffer::UndoGroup& undo_group);
    103 
    104 String generate_buffer_name(StringView pattern);
    105 
    106 }
    107 
    108 #endif // buffer_utils_hh_INCLUDED