kakoune/src/filter.hh

#ifndef filter_hh_INCLUDED
#define filter_hh_INCLUDED

#include "string.hh"
#include "selection.hh"
#include <functional>

namespace Kakoune
{

class Buffer;
class BufferIterator;

// A Filter is a function which is applied to a Buffer and a pending
// Modification in order to mutate the Buffer or the Modification
// prior to it's application.

using FilterFunc = std::function<void (Buffer& buffer, Selection& selection, String& content)>;
using FilterAndId = std::pair<String, FilterFunc>;

}

#endif // filter_hh_INCLUDED
Buffer: add filter support filters are functions called prior to applying a modification to a buffer. They can manipulate the modification to change the editor behaviour. 2011-12-02 15:28:27 +01:00			`#ifndef filter_hh_INCLUDED`
			`#define filter_hh_INCLUDED`

replace std::string references with String 2012-04-14 03:17:09 +02:00			`#include "string.hh"`
Pass the selection instead of only point of insertion to filters 2012-11-19 13:40:23 +01:00			`#include "selection.hh"`
Buffer: add filter support filters are functions called prior to applying a modification to a buffer. They can manipulate the modification to change the editor behaviour. 2011-12-02 15:28:27 +01:00			`#include <functional>`

			`namespace Kakoune`
			`{`

			`class Buffer;`
Buffer: move back Modification as an implementation detail * Filters now only works on insertion and take directly the iterator and content * use Buffer::insert and Buffer::erase to modify a buffer 2012-08-10 19:12:43 +02:00			`class BufferIterator;`
Buffer: add filter support filters are functions called prior to applying a modification to a buffer. They can manipulate the modification to change the editor behaviour. 2011-12-02 15:28:27 +01:00
Document some Kakoune concepts, as Window, Buffer, DisplayAtom... 2012-01-11 15:21:58 +01:00			`// A Filter is a function which is applied to a Buffer and a pending`
			`// Modification in order to mutate the Buffer or the Modification`
			`// prior to it's application.`

Pass the selection instead of only point of insertion to filters 2012-11-19 13:40:23 +01:00			`using FilterFunc = std::function<void (Buffer& buffer, Selection& selection, String& content)>;`
			`using FilterAndId = std::pair<String, FilterFunc>;`
Buffer: add filter support filters are functions called prior to applying a modification to a buffer. They can manipulate the modification to change the editor behaviour. 2011-12-02 15:28:27 +01:00
			`}`

			`#endif // filter_hh_INCLUDED`