edbee lib

Эдби-Либ

Edbee - это компонент редактора на основе QT. Он поддерживает несколько картевых каретов, обзор/грамматики Textmate и выделение поддержки.

Базовый класс Edbee - это Qwidget, он был написан с нуля и не основан на компонентах редактора QT по умолчанию.

Основной веб -сайт Edbee - http://edbee.net/ Вы можете найти сгенерированную документацию по адресу http://docs.edbee.net/

Этот репозиторий является чистой добычей предыдущего монолитивного репозитория EDBEE. Эта библиотека не содержит никаких файлов данных. Использование должно стать таким же простым, как и следующий пример:

# include " edbee/edbee.h "
edbee::TextEditorWidget* widget =  new edbee::TextEditorWidget();

К сожалению, мы еще не на этом этапе. В настоящее время библиотека EDBEE не будет функционировать без загрузки файла KeyMap по умолчанию.

Примеры

Использовать компонент довольно просто. Сначала вы должны настроить среду Edbee. Этот процесс необходим для того, чтобы библиотека знала местоположение файлов настроек:

# include " edbee/edbee.h "

// get the edbee instance
edbee::Edbee* tm = edbee::Edbee::instance();

// configure your paths
tm -> setKeyMapPath ( " location/of/your/keymap/ " );
tm -> setGrammarPath (  " location/of/your/syntaxfiles/ " );
tm -> setThemePath ( " location/of/your/themes/ " );

// initialize the library
tm -> init ();

// by registering a shutdown function on application exit you don't have to destroy the edbee
// resources yourself. It will result in a clean shutdown
tm -> autoShutDownOnAppExit ();

После этого вы готовы к работе. Вы можете создать такой виджет, как это:

edbee::TextEditorWidget* widget =  new edbee::TextEditorWidget();

Конечно, было бы также приятно заполнить редактор файлом. Вы можете использовать прилагаемый сериализатор для этого.

# include " edbee/io/textdocumentserializer.h "
# include " edbee/texteditorwidget.h "

edbee::TextEditorWidget* widget =  new edbee::TextEditorWidget();
edbee::TextDocumentSerializer serializer ( widget-> textDocument () );
QFile file ( QStringLiteral( " your-filename.rb " ) );
if ( !serializer.load( &file ) ) {
    QMessageBox::warning ( this , tr ( " Error opening file " ), tr ( " Error opening file! n %1 " ). arg (serializer. errorString ()) );
}

После загрузки текстового файла приятно обнаружить грамматику/язык этого файла. Библиотека EDBEE использует обнаружение файла на основе расширения. Конечно, вы также можете настроить свой собственный.

# include " edbee/edbee.h "
# include " edbee/models/textdocument.h "
# include " edbee/models/textgrammar.h "
# include " edbee/texteditorwidget.h "

TextGrammarManager* grammarManager = edbee::Edbee::instance()-> grammarManager ();
TextGrammar* grammar = grammarManager-> detectGrammarWithFilename ( " a-ruby-file.rb " );
widget-> textDocument ()->setLanguagGrammar( grammar );

Авто завершено

Edbee поддерживает автозаполнение. В настоящее время это очень ограничено, но основы были сделаны для поддержки более продвинутых автозаполнений.

Auto Complete Works путем запроса поставщиков автозаполнения (TextautocOmpletEprovider). Он имеет TextAutocOfleteProviderList на уровне TextDocument и глобально через уровень EDBEE :: Extance ().

В настоящее время реализован только stringtextautocompleteprovider. Вы можете добавить список автозаполнения на уровне документа и уровня Эдбеля.

Идеи на будущее

• Он должен использовать нечеткий поиск
• Слова должны получить приоритет и должны быть отсортированы с этим приоритетом
• Поставщики, основанные на существующих словах в текущем TextDocument. (Это требует некоторого интеллектуального здания Word-List), не блокирующего UI)
• Поставщик на основе текущей области. Ключевые слова в зависимости от Active TextDocumentsCopes (специфичные для языка/контекстные списки)
• Поддержка Textmate/Sublime, как фрагменты (с остановками вкладок)

В настоящее время вы можете установить список ключевых слов, как это:

# include " edbee/models/textautocompleteprovider.h "

StringTextAutoCompleteProvider* provider = new StringTextAutoCompleteProvider();
provider-> add ( " const " );
provider-> add ( " class " );
provider-> add ( " compare " );
// etc ...

// to add it Locally (specific to the given document)
textDocument-> autoCompleteProviderList ()->giveProvider(provider);

// to add it Globally:
Edbee::instance ()->autoCompleteProviderList()->giveProvider(provider);

Известные проблемы

• Элементы еще не отсортированы (это должно быть приоритетным сортом)
• В настоящее время позиция окна Autcomplete не очень умна. (Особенно в нижней и стороне документа)
• Backspace скрывает окно

Советы и хитрости

Объектные конфликты

Когда вы используете QT Projects, например, UTIL.CPP, вы можете получить коллиссию с объектом. (Makefile: Предупреждение: переопределение команд для Target util.o). Обходной путь для этого - добавление следующих строк в вашем (ObjectS_DIR является необязательным, но предотвращает предупреждение при запуске QMake)

 CONFIG += object_parallel_to_source in your .pro file
OBJECTS_DIR = objects

Известные проблемы и отсутствующие особенности

• Редактор не поддерживает слов. (еще)
• У него есть проблемы с длинными линиями. Причиной этого является природа QTextLayout и поддержка переменных размеров шрифтов. В будущем это может быть исправлено для моносированных шрифтов.
• Оптимизации для лучшей поддержки и фона вычисления/фон/краски функциональности
• Я действительно хочу создать поддержку сценариев, чтобы расширить редактор с помощью плагинов.

Внося

Вы можете внести свой вклад через GitHub

• Разветвляй это
• Создайте филиал своей функции (GIT Checkout -b моя новая функция)
• Совершить свои изменения (git commit -am 'добавил некоторую функцию')
• Толкайте к ветке (git push Origin My-Newfecture)
• Создать новый запрос на привлечение

Конечно, вы также можете внести свой вклад, связавшись со мной через Twitter @gamecreature или бросить мне сообщение по электронной почте, поставляемое по адресу https://github.com/gamecreature

Проблемы?

Несмотря на то, что у нас есть свой собственный проблему с проблему по адресу (http://issues.edbee.net/), вы можете сообщить о своих проблемах через трекер выпуска Github или отправить мне сообщение https://github.com/gamecreature