Изучаем EDE
Чтобы понять, выбросить, или простить.

Рассмотрим содержание папки /usr/share/emacs/версия emacs/lisp/cedet/ede/

Разузнав про реализацию ООП в elisp, а именно EIEIO, узнаем про то как задаются классы и наследование через defclass. Смотрим описание файлов и что в них задано.

Смотрим на наследование классов, а также описания в заголовках файлов. Из базовых классов ede-project ede-target вырисовываются следующие крупные группы.

• ede-proj-project - это проекты хранящиеся в Project.ede рассчитано в основном на Makefile
• project-am-makefile - рассчитано на работу с Automake
• ede-simple-project - устарел(хах) смотри дальше.
• ede-generic-project - упрощенный способ создавать "проекты" или встраиваться в проект с уже написанным конфигом.
• ede-cpp-root-project - хак поверх ede , из плюсов прописка путей к библиотекам, для точного автодополнения через semantic.
• ede-emacs-project и ede-linux-project специально написанные костыльные файлы для работы с крупными проектами.

Теперь по файлам с кодом в папке с ede:

• ../ede.el здесь описание мода и как его грузить и подключать в emacs
• base.el Содержит базовые файлы для работы с ede
• config.el и generic.el для работы с generic проектами а также поиск и детектирование проекта, по файлу конфига а не по проектному файлу как .ede
• auto.el подгрузка списка типов проектов.
• proj.el базовые классы ede-proj-project
  • pconf.el Генератор конфига для automake
  • pmake.el Генератор конфига make
  • proj-obj.el Класс для целей программных объектов программы или библиотеки
  • proj-prog.el Работа с целями Программами
  • proj-shared.el Работа с целями - Динамическая библиотека
  • proj-archive.el Цель создания архивов с кодом
  • proj-aux.el Работа со второстепенными объектами вроде документации
  • proj-comp.el Компиляторы, линкеры
  • proj-elisp.el Работа с elisp файлами
  • proj-info.el Работа с генерацией документации вида info
  • proj-misc.el Подключение собственных makefile пользователя.
  • proj-scheme.el Работа с Scheme(Guile) файлами
• project-am.el ; project-am создание структур и работа с Automake проектами
  • makefile-edit.el
  • autoconf-edit.el
• cpp-root.el Быстрая работа с C++ проектами.
• emacs.el Специальный проект для специальной программы
• linux.el Ещё один спец проект для ядра линукс
• loaddefs.el - чего-то специальное для пакета, похоже на import в python
• locate.el ищем тэги в проекте и прочее для автодополнения
• dired.el настраиваем dired для ede
• files.el сканирование папок и файлов проекта
• custom.el Настройка проекта через customization интерфейс
• detect.el Обнаружение файлов для автозагрузки
• speedbar.el Представление проекта в Speedbar
• srecode.el Доп функции для работы с подстановкой в шаблоны через srecode
• system.el Работа с системой ,там CSV и FTP, SSH
• shell.el Запуск команд в оболочке связанное с проектом.
• util.el Несмотря на громкий заголовок, тут только функция обновляющая версию софта в заголовках файлов.
• make.el Выбор make программ, если есть выбор
• simple.el Для simple-project
• source.el Объекты файлов с исходными кодами и определение свойств, вроде языка используемого в файле.

Кстати вот для proj проектов этапы генерации Makefile

;;; Commentary:
;;
;; Code generator for Makefiles.
;;
;; Here is how it should work:
;; 1) Collect information about the project and targets
;; 2) Insert header into the Makefile
;; 3) Insert basic variables (target/source)
;; 4) Conditional
;;    a) Makefile
;;       1) Insert support variables (compiler variables, etc)
;;       2) Insert VERSION and DISTDIR
;;       3) Specify top build dir if necessary
;;       4) Specify compile/link commands (c, etc)
;;       5) Specify dependency files
;;       6) Specify all: target
;;       7) Include dependency files
;;       8) Insert commonized target specify rules
;;       9) Insert clean: and dist: rules
;;    b) Automake file
;;       1) Insert distribution source variables for targets
;;       2) Insert user requested rules

Теперь посмотрим что реально происходит. Итак cedet сейчас идет в основной поставке emacs(удивительно при этом хоть программа и заброшена в основной поставке чуток протухший вариант.).

Следующий строчки есть в моём конфиге.

;; Load Project.ede
(require 'cedet)
(require 'eieio)
(require 'eieio-speedbar)
(require 'eieio-opt)
(require 'eieio-base)
(require 'ede/source)
(require 'ede/base)
(require 'ede/auto)
(require 'ede/proj)
(require 'ede/proj-archive)
(require 'ede/proj-aux)
(require 'ede/proj-comp)
(require 'ede/proj-elisp)
(require 'ede/proj-info)
(require 'ede/proj-misc)
(require 'ede/proj-obj)
(require 'ede/proj-prog)
(require 'ede/proj-scheme)
(require 'ede/proj-shared)

(semantic-mode 1)

(global-ede-mode t)

Итак у нас проект. Файл main.cpp с подключенным локальным room.h и класс Room описанный в room.h ,реализованный в room.cpp, используемый в main.cpp

Делаем(проверьте что ваш тестовый проект итак компилируется).

1. Открываем в emacs файл main.cpp
2. Используем Development->Create Project либо M-x ede-new
3. Выбираем тип проекта Makefile кстати так как у меня не подключены ede/linux ede/emacs то видимо их в проектах и нет.
4. Выбираем создать новую цель M-x ede-new-target или C . t
5. Выбираем имя запускаемого файл, тип цели программа program и имя годового бинарника
6. Открываем файл room.h нам предложат добавить его в цель, либо если предложения не поступит Added File (С . a)
7. Открываем файл room.cpp нам предложат добавить его в цель, либо если предложения не поступит Added File (С . a)

Смотрим как выглядит сгенерированный файл.

;; Object ede-proj-project-15f5a24
;; EDE Project Files are auto generated: Do Not Edit
(ede-proj-project "ede-proj-project-15f5a24"
  :file "Project.ede"
  :name "killzone"
  :targets
  (list
    (ede-proj-target-makefile-program "ede-proj-target-makefile-program-16c017c"
      :name "automa"
      :path ""
      :source '("main.cpp" "room.cpp")
      :auxsource '("room.h"))))

• Теперь компелируем M-x ede-compile-target (С . c)

Пример проекта лежит в здесь.

Так как проект CEDET использует ООП, то надо посмотреть что за объектами он оперирует и что эти объекты могут.

Возьмем пример, отсылающий букву 'A' по UART и попытаемся его собрать.

В проекте лежит файл AVR_true.mk с Makefile

PROGRAM = uart_clear_c_tx
MCU = atmega32u4
CC = avr-gcc
OBJCOPY = avr-objcopy
CFLAGS += -Wall -g -Os -mmcu=$(MCU)
LDFLAGS +=
OBJS = $(PROGRAM).o

# Be silent per default, but 'make V=1' will show all compiler calls.
V = 1
ifneq ($(V),1)
Q := @
endif

all: $(PROGRAM).hex

$(PROGRAM).elf: $(PROGRAM).o
	@printf "  LD      $(subst $(shell pwd)/,,$(@))\n"
	$(Q)$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $^

$(PROGRAM).hex: $(PROGRAM).elf
	@printf "  OBJCOPY $(subst $(shell pwd)/,,$(@))\n"
	$(Q)$(OBJCOPY) -O ihex $< $@

%.o: %.c
	@printf "  CC      $(subst $(shell pwd)/,,$(@))\n"
	$(Q)$(CC) $(CFLAGS) -o $@ -c $<

flash: $(PROGRAM).hex
	@printf "  FLASH   $(PROGRAM).hex\n"
	$(Q)avrdude -c avrispv2 -P usb -p t13 -U flash:w:$(PROGRAM).hex

Вроде ничего сложного, цель для программы, для создания hex файла и цель для прошивки. Используя возможности ede-proj-project максимум на что удалось приблизится это

;; Object ede-proj-project-1564b16c95dc
;; EDE Project Files are auto generated: Do Not Edit
(ede-proj-project "ede-proj-project-1564b16c95dc"
  :file "Project.ede"
  :name "AVR example"
  :targets
  (list
    (ede-proj-target-makefile-program "ede-proj-target-makefile-program-1564b20547a8"
      :name "main.elf"
      :path ""
      :source '("uart_clear_c_tx.c")
      :configuration-variables nil
      :rules
      (list
        (ede-makefile-rule "ede-makefile-rule-1564b1fc1f38"
          :target "flash"
          :dependencies "main.hex"
          :rules '("avrdude -c avrispv2 -P usb -p t13 -U flash:w:main.hex")
          :phony t)
        (ede-makefile-rule "ede-makefile-rule-1564b1fe3338"
          :target "main.hex"
          :dependencies "main.elf"
          :rules '("$(OBJCOPY) -O ihex $< $@"))))
    (ede-proj-target-makefile-miscelaneous "ede-proj-target-makefile-miscelaneous-1564b2081754"
      :name "main.h"
      :path ""
      :source '("uart_clear_c_tx.c")))
  :variables '(("CC" . "avr-gcc") ("MCU" . "atmega32u4") ("CFLAGS" . "-Wall -g -Os -mmcu=$(MCU)") ("OBJCOPY" . "avr-objcopy"))
  :configuration-variables nil
  :inference-rules
  (list
    (ede-makefile-rule "ede-makefile-rule-1564b1eb48d4"
      :target "%.hex"
      :dependencies "%.elf"
      :rules '("$(OBJCOPY) -O ihex $< $@"))))

И то запускается это все через пень колоду, т.к. не могу написать что после компиляции мне ещё нужна и конвертация из elf в hex. Такого понятия нет в настройках, как и переопределения шаблона применяемого для цели. Т.е. вот эта куча кода, а выигрыша нет. Что уж говорить о генерации вывода дизассемлера, запуск simulavr и прошивка туда программы.

На всякий случай, что мы здесь задали: новые цели и правила, внутренние переменные, ещё можно подключить готовый Makefile, но тут вопрос как нам к нему цели их вывод подвязать например называть все цели в проектах - main и подвязывать команды к таким именам как main_SOURCE main_OBJ и как-то переопределить цель all.

Вы самостоятельно можете сравнить исходный AVR_true.mk и тот что генерируется из проект Project.ede (Makefile)

Возможно, можно использовать ede-cpp-root-project и указать там напрямую compile-command оставив наш шаблонный Makefile, но это не выход.

Итак нам понадобиться

• elisp пакет arduino-mode
• arduino-ide по умолчанию проект выше привязан к системному пути, мы же рассмотрим выкачанное и распакованное свежее IDE.
• Arduino-Makefile тоже надо выкачать.

Чем хорошо Arduino-mode это пример того как человек решился сделать полноценную поддержку диалекта языка, даже разобрался с добавлением проектов в EDE, подсветкой синтаксиса, это очень круто.

Смотрим как реализована поддержка EDE в .emacs.d/elpa/arduino-mode-*/ede-arduino.el

Там есть свой класс ede-arduino-project от погдружается через autoload , не требует проектного файла размещенного в корне каталога или записи в emacs конфигах, так как привязка идет по файлу с характерным расширение .ino или .pse, схожим образом вроде как должны действовать generic проекты.

Не будем смотреть на грустную сторону, а именно работу с CMake или кем-то написанным проектом с ручным autoconf, makefile итд. Также не будем про интеллектуальное детектирование типов проектов.

Что мы можем, ставить менять значения переменных в Makefile

Мы можем подгружать сторонние куски Makefile как пример Arduino.mk полностью сторонний.

local-variables – переопределяет непонятно что, т.е. для generic проекта есть переменные вроде compile-command но вот в proj есть поля.

Ещё мы можем подключаться к чужим проектам через generic-projects и запускать сборку или отладку, но есть подозрения что projectile делает это лучше и проще. Вообще надо будет ещё раз пересмотреть видео Дмитрия Бушенко о EDE и заставить работать generic проекты.

И да у нас нет шаблонных проектов ,от слова совсем. То как выглядят и реализованы linux-project emacs-project и cpp-project да тот же ардуино в рамках данной системы этого не то что чудовищно, это ужас, столько кода, а результат пшик.

Сами проекты не разделены, на сборку, загрузку, типы сборочных инструментов прибиты к Make и Automake и даже то что есть этого недостаточно, например когда вам нужно по мимо, компиляции сделать hex, сделать листинг дизассемлера итд итп. В EDE используется работа с шаблонами через srecode, не знаю на сколько он современен и лучше/хуже YasSnippet в этих задачах.

Документации мало, тестовых проектов тоже в папке не валяется. И самое главное за столько лет ничего и не появилось, есть cmake-ide и все и тишина, тишина. Для простых проектов когда лень писать makefile он вполне сойдет, сложные будут использовать его по минимуму как просмотр папок и быстрая привязка к горячей клавише компиляции/запуска.

Если у меня будет время(скорее всего нет) то надо:

• Разобраться с другими элементами CEDET с которыми взаимодействует EDE
• Посмотреть projectile (это видимо придется сделать)
• Вырезать весь лишний функционал вроде web сайта и прочего распространения.
• Оставить работу через шаблоны, подгрузку через autoload и детектирование
• Пользовательские конфигурации.

Вот ещё из интересных ссылок подгрузка cpp проекта где EDE использует данные полученные от projectile и привязывается к файлу проектов projectile.

В ближайшее тысячелетие, постараюсь посмотреть возможна ли нормальная работа rtags или lsp-client(eglot) для работы с C++ , но лучше если Вы сразу поделитесь своими впечатлениями.