Простий текстовий редактор на Ultimate ++

C++, U++, Ultimate++, UPP

Про Ultimate++ ( https://www.ultimatepp.org/ ) я дізнався зовсім випадково, коли прочитав в айтішній новинній RSS-стрічці про чергове оновлення цього фреймворку. Що ж, подумав я, раз мої пен-проекти поки що у загальмованому стані, чому б не спробувати щось нове.

Ultimate++ (скорочено U++ або UPP) є кросплатформним фреймворком для розробки GUI-додатків на основі C++. Крім коду самого фреймворку до складу входить власний збирач BLITZ та середовище розробки TheIDE для редагування коду та елементів GUI.

Спробуємо написати найпростіший блокнот на основі U++.

Завантажуємо із сайту zip-архів з фрейворком, розпаковуємо в будь-яку зручну директорію та запускаємо середовище розробки TheIDE.
Перше, що пропонується середовищем, - вибрати пакет (package) або створити новий пакет програми. Є ще варіант створити нову колекцію (assembly) пакетів. Крім того, можна вибрати наявні колекції. З існуючих колекцій є різні приклади.

Отже, створимо нову колекцію. Для цього в поле колекцій потрібно викликати контекстне меню та вибрати пункт New assembly (Нова колекція). У вікні є три рядкові поля введення: "Package nests" (Гнізда пакетів), "Output directory" (Директорія виведення), "Assembly name" (Ім'я колекції). У "Package nests" вже внесені шляхи до пакетів краще не видаляти. А ось додати свій шлях потрібно. Викликаємо редактор гнізд пакетів, натиснувши на кнопку з трьома крапками праворуч від поля введення. У вікні вносимо зручний шлях до своїх файлів, переміщаємо кнопками зі стрілками цей шлях на перше місце і натискаємо «ОК». У «Output directory», у свою чергу, вносимо зручний шлях для вихідних файлів після компіляції та лінкування. І пишемо в "Assembly name" ім'я, яким колекція буде представлена у списку колекцій. Все, тиснемо "ОК".

Тепер створимо новий пакет. Для цього натискаємо кнопку «New package», розташовану в правому нижньому кутку основного вікна TheIDE.
У діалоговому вікні є кілька варіантів створення пакета. Вибираємо «U++ CtrlLib application with main window», з використанням бібліотеки CtrlLib, куди, крім іншого, входять екранні віджети, що цікавлять нас, і лейаутом головного вікна. Вводимо у поле ім'я пакета і натискаємо «OK».

Після цього відкривається основне вікно The IDE.
Зліва зверху розташоване вікно, де відображаються підключені до пакета інші пакети. Ліворуч знизу — вікно зі згенерованими щойно файлами нашого пакета. Справа відображається структура поточного файлу пакета. По центру – редактор коду.
Всього створено три файли: UppNotepad2.h , main.cpp та UppNotepad2.lay . Попереджу питання, чому "2": з першою версією блокнота я помилився, і при виборі типу пакета вказав простий додаток без головного вікна, і файл *.lay не був створений, а без нього нам не обійтися.

З першими двома файлами зрозуміло, це вихідний код нашого блокнота. Третій файл, UppNotepad2.lay – лейаут головного вікна програми. Розглянемо кожен із них докладно.

#ifndef _UppNotepad2_UppNotepad2_h
#define _UppNotepad2_UppNotepad2_h

#include <CtrlLib/CtrlLib.h>

using namespace Upp;

#define LAYOUTFILE <UppNotepad2/UppNotepad2.lay>
#include <CtrlCore/lay.h>

class UppNotepad2 : public WithUppNotepad2Layout<TopWindow>
{
public:
    typedef UppNotepad2 CLASSNAME;
    UppNotepad2();
};

#endif

#include "UppNotepad2.h"

UppNotepad2::UppNotepad2()
{
    CtrlLayout(*this);
}

GUI_APP_MAIN
{
    UppNotepad2().Run();
}

Цей код генерується автоматично і редагування не потребує.

Для лейауту існує два режими перегляду: у графічному та текстовому вигляді.

LAYOUT(ppNotepad2Layout, 200, 100)
END_LAYOUT

Є ще четвертий файл, розміщений у директорії пакета — UppNotepad2.upp . Цей файл у TheIDE не показується, він потрібен лише для збирання пакета.

Почнемо розробляти наш додаток з лейауту.
Курсор наводимо на сіре поле лейауту і в контекстному меню вибираємо послідовно: «Editors – DocEdit». На лейауті з'являється віджет редагування тексту. Налаштуємо його. Для цього виділимо віджет. У середній частині знизу з'являється вікно з властивостями елемента. Праворуч від типу елемента є поле введення імені віджету. Введемо туди "editor".

Також налаштуємо тип та розмір шрифту. Для цього клацнемо по полю введення "SetFont" і діалоговому вікні, що відкрилося, вкажемо тип шрифту "Monospace", розмір 12.

І налаштуємо залежність розташування елемента від розмірів головного вікна.

Тепер перейдемо до заголовного файлу.

Оголосимо елементи головного вікна та змінні:
- MenuBar menu — рядок меню;
- ToolBar tool - панель інструментів;
- StatusBar status - рядок стану;
- String fileName — ім'я файлу, що редагується;
- String loadText - завантажений текст файлу.

Оголосимо такі методи для роботи з текстом та файлами:
- void OpenCmd() - відкрити файл;
- void SaveCmd() - зберегти файл;
- void SaveAsCmd() - зберегти файл як;
- void ExitCmd() - закрити програму;
- void CutCmd() - вирізати текст;
- void CopyCmd() - копіювати текст;
- void PasteCmd() - вставити текст;
- void UndoCmd() - скасувати останню дію;
- void RedoCmd() - повторити останню дію.

Також перевизначимо метод virtual void Close() вікна TopWindow для випадку, коли натиснуто кнопку закриття вікна.

І визначимо методи, що формують меню на основі бібліотечного елемента Bar:
- void FileBar(Bar&bar) — меню/панель інструментів "Файл";
- void EditBar(Bar&bar) — меню/панель інструментів «Редагувати»;
- void MainBar(Bar&bar) - панель інструментів;
- void MainMenu(Bar&bar) — меню, що випадає.

class UppNotepad2 : public WithUppNotepad2Layout<TopWindow>
{
public:
    typedef UppNotepad2 CLASSNAME;
    UppNotepad2();

    MenuBar menu;
    ToolBar tool;
    StatusBar status;
    String fileName;
    String loadText;

    void OpenCmd();
    void SaveCmd();
    void SaveAsCmd();
    void ExitCmd();

    void CutCmd();
    void CopyCmd();
    void PasteCmd();
    void UndoCmd();
    void RedoCmd();

    void FileBar(Bar& bar);
    void EditBar(Bar& bar);
    void MainBar(Bar& bar);
    void MainMenu(Bar& bar);

    virtual void Close();
};

Перейдемо до файлу реалізації.
Для відкриття файлів є метод UppNotepad2::OpenCmd() . У ньому використовується діалог FileSel для вибору файлів, метод Type діалогу для налаштування відображення файлів з розширенням *.txt та метод Get() для отримання повного шляху до файлу. Крім того, використовується утиліта FileIn для відкриття файлу на читання та утиліта LoadFile для завантаження файлу в текстовий редактор.

void UppNotepad2::OpenCmd()
{
    FileSel fs;
    fs.Type("Текстовые файлы (*.txt)", "*.txt");
    if(fs.ExecuteOpen("Открыть файл"))
    {
        fileName = fs.Get();
        FileIn fi(fileName);
        if(!fi)
        {
            PromptOK("Не могу открыть файл!");
            return;
        }
        loadText = LoadFile(fileName);
        editor.Set(loadText);
    }
}

У методах UppNotepad2::SaveCmd() та UppNotepad2::SaveAsCmd() використовується утиліта SaveFile для збереження файлу.

void UppNotepad2::SaveCmd()
{
    if(!SaveFile(fileName, editor.Get()))
        PromptOK("Не могу сохранить файл!");
}

void UppNotepad2::SaveAsCmd()
{
    FileSel fs;
    fs.Type("Текстовые файлы (*.txt)", "*.txt");
    if(fs.ExecuteSaveAs("Сохранить файл как"))
    {
        fileName = fs.Get();
        if(!SaveFile(fileName, editor.Get()))
            PromptOK("Не могу сохранить файл!");
    }
}

У методі ExitCmd() перевіряється, чи змінено текст, і якщо змінено, користувач запитує, чи зберегти текст. У випадку, якщо користувач погоджується зберегти текст, викликається або SaveCmd() , якщо файл був раніше відкритий, або SaveAsCmd() , якщо новий файл.

void UppNotepad2::ExitCmd()
{
    String curText = editor.Get();
    if(!(loadText == curText))
    {
        if(PromptOKCancel("Сохранить файл?"))
        {
            if(!fileName.IsEmpty())
                SaveCmd();
            else
                SaveAsCmd();
        }
    }
    Break();
}

void UppNotepad2::Close()
{
    ExitCmd();
}

Вирізання тексту, а також копіювання та його вставка, скасування дії та повторення дії виконуються за допомогою відповідних методів віджету DocEdit . У віджеті вшиті гарячі клавіші для цих дій.

void UppNotepad2::CutCmd()
{
    editor.Cut();
}

void UppNotepad2::CopyCmd()
{
    editor.Copy();
}

void UppNotepad2::PasteCmd()
{
    editor.Paste();
}

void UppNotepad2::UndoCmd()
{
    editor.Undo();
}

void UppNotepad2::RedoCmd()
{
    editor.Redo();
}

Розглянемо код створення меню.
За додавання пункту меню і кнопки панелі інструментів відповідає метод Add() , причому працює він по-різному залежно від аргументів. Якщо вказано шлях до іконки, як це зроблено, наприклад, для команди «Зберегти», то створиться і пункт меню, що випадає, і кнопка на панелі інструментів. Якщо іконка не вказана (див. команду «Зберегти як…»), то створюється лише пункт меню. Макрос THISBACK дозволяє підключити відповідний метод до елементу меню. У методі Help() вписується рядок контекстної допомоги, що відображається у рядку стану. Метод Separator() додає розділову смугу як у меню, так і в панель інструментів.

void UppNotepad2::FileBar(Bar& bar)
{
    bar.Add("Открыть", StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\open.png"), THISBACK(OpenCmd)).Help("Открыть файл");
    bar.Add("Сохранить", StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\save.png"), THISBACK(SaveCmd)).Help("Сохранить файл");
    bar.Add("Сохранить как...", THISBACK(SaveAsCmd)).Help("Сохранить как");
    bar.Add("Выйти", THISBACK(ExitCmd)).Help("Выход из программы");
}

void UppNotepad2::EditBar(Bar& bar)
{
    bar.Add("Вырезать (Ctrl + X)", StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\cut.png"), THISBACK(CutCmd)).Help("Вырезать выделенный текст в буфер");
    bar.Add("Копировать (Ctrl + C)", StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\copy.png"), THISBACK(CopyCmd)).Help("Копировать выделенный текст в буфер");
    bar.Add("Вставить (Ctrl + V)", StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\paste.png"), THISBACK(PasteCmd)).Help("Вставить текст из буфера");
    bar.Separator();
    bar.Add("Отменить (Ctrl + Z)", StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\undo.png"), THISBACK(UndoCmd)).Help("Отменить последнее действие");
    bar.Add("Повторить (Ctrl + Shift + Z)", StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\redo.png"), THISBACK(RedoCmd)).Help("Повторить последнее действие");
}

void UppNotepad2::MainBar(Bar& bar)
{
    FileBar(bar);
    bar.Separator();
    EditBar(bar);
}

void UppNotepad2::MainMenu(Bar& bar)
{
    bar.Add("Файл", THISBACK(FileBar));
    bar.Add("Редактировать", THISBACK(EditBar));
}

Тепер розглянемо конструктор UppNotepad2 .

UppNotepad2::UppNotepad2()
{
    // Устанавливаем лэйаут
    CtrlLayout(*this);

    loadText = "";

    // Устанавливаем цвет текста
    editor.SetColor(TextCtrl::INK_NORMAL, Color(255, 255, 255));
    // Устанавливаем цвет фона
    editor.SetColor(TextCtrl::PAPER_NORMAL, Color(0, 0, 0));
    // Убираем горизонатльную полосу, обозначающую конец файла
    editor.EofLine(false);

    // Устанавливаем заголовок окна, указываем, что окно будет изменяемым, с кнопками минимизации и развёртывания окна
    // и что окно будет развёрнуто максимально
    Title("Upp Notepad 2").Sizeable().MinimizeBox().MaximizeBox().Maximize(true);
    // Устанавливаем иконку заголовка окна
    Icon(StreamRaster::LoadFileAny("E:\\dev\\upp\\UppNotepad2\\images\\editor.png"));
    // Добавляем в окно выпадающее меню
    AddFrame(menu);
    // Добавляем разделитель выпадающего меню и панели инструментов
    AddFrame(TopSeparatorFrame());
    // Добавляем панель инструментов
    AddFrame(tool);
    // Добавляем строку состояния
    AddFrame(status);
    // Устанавливаем меню
    menu.Set(THISBACK(MainMenu));
    // Перенаправляем вывод Help() в строку состояния
    menu.WhenHelp = status;
    // Устанавливаем панель инструментов
    tool.Set(THISBACK(MainBar));
    tool.WhenHelp = status;
}

Для приховування платформозалежних деталей реалізації замість функції main() використовується макрос GUI_APP_MAIN**.

GUI_APP_MAIN
{
    UppNotepad2().Run();
}

Ось результат виконання коду.

Щоб додати піктограму програми на робочий стіл, необхідно підключити файл *.rc. Для цього в будь-якому текстовому редакторі пишемо наступний рядок:

9999 ICON "images/editor.ico"

та зберігаємо її у файл UppNotepad.rc у каталозі з вихідними джерелами нашої програми. Далі у полі файлів TheIDE викликаємо контекстне меню і вибираємо пункт «Insert package directory file(s)» і вибираємо щойно створений файл. Це необхідно, щоб файл *.rc потрапив у пакет і брав участь у збиранні пакета.

Висновки

Переваги фреймворку:
- не потрібно встановлення дистрибутива, достатньо розпакувати zip-архів у відповідну директорію, і всі інструменти стають доступними;
- велика основа прикладів;
- Простота освоєння;
- Хороша документація;
- на виході виходить один виконуваний файл, який вимагає ніяких залежностей.

Недоліки:
- на сайті легше скористатися пошуком по сайту, ніж у деяких випадках переходити за побитими посиланнями;
- одне відкрите вікно TheIDE підтримує лише один відкритий головний проект-пакет. Це обходиться тим, що можна відкрити другий та наступні екземпляри TheIDE. У якомусь сенсі так навіть зручніше перемикатися між вікнами можна за допомогою Alt+Tab;
- у редакторі текстів TheIDE не працює автодоповнення для ключових слів та змінних, які починаєш вводити з нового рядка;
- Віджети GUI можна створити тільки в лейаут, через код їх створювати не можна;
- Непереносимість коду з машини на машину. (Код редактора я писав на одному комп'ютері, повторну перевірку працездатності коду перевіряв іншою машиною. В результаті «відвалився» rc-файл і видавав помилку при компіляції. Це пов'язано з тим, що у файлі *.upp був прописаний абсолютний шлях до файлу. Довелося підключати повторно.)