Инструменты пользователя

Инструменты сайта


courses:programming:course_work:spring_requirements

Требования к CLI для курсовой работы весеннего семестра

В случае использования систем сборки в курсовой работы (например, make), то исполняемый файл курсовой работы должен называться cw!

CLI (Command Line Interface)

Курсовую работу требуется реализовать в виде утилиты, подобной стандартным linux-утилитам: управление осуществляется посредством аргументов командной строки. Конкретный список команд зависит от решаемой задачи, но в общем случае обязательно:

  • Наличие справки, которая распечатывается при вызове утилиты без аргументов или стандартными ключами (-h, –help)
  • Обязательная обработка всех возможных исключительных ситуаций (даже бьющийся в агонии по клавиатуре пользователь не должен привести программу к аварийному завершению неверными аргументами)
  • Для всех ключей должны быть как полные, так и сокращенные версии (-h, –help)
  • По умолчанию последним аргументом утилите должно передаваться имя входного bmp/png файла, если не задан ключ -i/–input. Имя выходного файла по умолчанию должно быть out.bmp (out.png для png), однако это должно быть возможным переопределить соответствующими ключом -o, –output '' * Курсовая работа должна иметь функцию печати подробной информации о bmp\png-файле (ключ ''–info)
  • В случае, если курсовой работой будут поддерживаться не все версии bmp/png-файлов, то программа должна выводить об этом внятное сообщение, а не аварийно завершаться.
  • Программа за один запуск выполняет только одно действие (если программа может рисовать прямоугольник и круг, то за один запуск рисуется либо прямоугольник, либо круг)
  • Для каждого инструмента должен быть соответствующий ключ и ключи для его настройки. Например, рисование прямоугольника может выглядеть так:
mypaint --rectangle --start 0 0 --end 100 50 --color red picture.bmp

Реализация интерфейса должна быть с использованием getopt или argp

Ссылки на ресурсы

Оси координат и начало отсчёта

Началом оси координат является верхний левый угол. Ось X расположена по горизонтали и растёт вправо. Ось Y расположена по вертикали и растёт вниз

Если в задании используется область, то вторая координата указывает на границу, которая не включается в область. Например, если заданы координаты 0.0 и 100.200, то рабочая область будет размером 100×200 (0 ≤ x < 100, 0 ≤ y < 200). Областью считается часть изображения, над которой необходимо провести какие-то действия, рисование линий и прямоугольников под определение области не попадает

Обязательные флаги

  • –input, -i: Задаёт имя входного изображения. При необходимости (если требуется по заданию), флаг может принимать несколько аргументов. Если флаг отсутствует, то предполагается, что имя входного изображения передаётся последним аргументом
  • –output, -o: Задаёт имя выходного изображения. При необходимости (если требуется по заданию), флаг может принимать несколько аргументов
  • –info: Печатает информацию об изображении и завершает работу
  • –help, -h: Выводит справку.
Первой строкой при запуске программы нужно выводить информацию о варианте курсовой работе и об авторе программы в строго определенном формате: Course work for option <V>, created by <Name> <Surname>. Где V – вариант курсовой и Имя и Фамилия, как указано в репозитории группы. Данное предложение должно быть строго первым предложением в выводе программы и является отдельной строкой (заканчивается знаком ‘\n’). Например: Course work for option 3.2, created by Ivan Ivanov.

Обработка ошибок

В случае ошибки и невозможности выполнить функцию по какой-либо причине, нужно вывести строку с ошибкой и завершить работу программы с кодом возврата из диапазона: [40-49]

Обработка ошибок при некорректных аргументах у флагов:

  • Если флаг отвечает за цвет и передано некорректное значение (например 500.0.10), то необходимо остановить выполнение и завершить работу с ошибкой
  • Если флаги отвечают за указания области так, что левый верхний угол ниже или правее правого верхнего, то необходимо остановить выполнение и завершить работу с ошибкой
  • Если флаг отвечает за координаты для рисования (например, для рисования линии) и координаты находится вне границ изображения, то необходимо продолжить обработку так, как если бы можно было выходить за рамки изображения. Пример: допустим на вход подано изображение размером 100×100 пикселей, начало отрезка 0.0, а конец отрезка 200.200. В таком случае должна быть нарисована диагональ. Если же начало отрезка было 150.130, то на изображении ничего не должно быть нарисовано, так как линия проходить за границами обрабатываемого изображения
  • Если флаг отвечает за координаты для области и координаты находится вне границ изображения, то необходимо продолжить обработку до максимально/минимально возможного значения координат
  • Если были введены аргументы для флага, который не принимает аргументов или введены лишние аргументы, то
    • Завершить работу с ошибкой, или
    • Вывести пользователю сообщение, что данные аргументы будут проигнорированы. Например, Аргументы 'best_arg' и 'another_best_arg' проигнорирован, так как флаг '–info' не принимает аргументов
  • Если введён аргумент, который не соответствует ожидаемому шаблону, то необходимо завершить работу с ошибкой
  • Если введён некорректный флаг или не хватает флагов для задания параметров, то необходимо завершить работу с ошибкой
  • Если имена входного и выходного файлов совпадают, то необходимо завершить работу с ошибкой
  • Если подается более двух действий (например, рисовать круг и квадрат), то необходимо завершить работу с ошибкой
courses/programming/course_work/spring_requirements.txt · Последнее изменение: — sergey_tinyakov