adabrowse - Інтернет у хмарі

ПРОГРАМА:

ІМ'Я

adabrowse - генерує HTML-рендеринг специфікацій Ada 95 із повними перехресними посиланнями

СИНТАКСИС

adabrowse [параметри] -f файл

ОПИС

adabrowse створює HTML-рендеринг специфікацій Ada 95 із повними перехресними посиланнями (без тіл)
подібно до того, що javadoc робить для джерел Java. adabrowse є утилітою командного рядка; Це має
відсутність графічного інтерфейсу.

adabrowse легко налаштовується за допомогою параметрів командного рядка, таблиць стилів і
файлів конфігурації.

adabrowse повністю розбирає вихідний код і створює документацію HTML
містить:
· Усі контекстні речення
· Заголовок блоку
· Якщо одиниця є пакетом:
— Усі винятки (включаючи перейменування)
— Усі константи
— Усі змінні
— Індекс типу, що містить усі типи та їхні примітивні операції (тільки останні
для (позначених) типів записів, приватних типів і типів, похідних від них). The
список примітивних операцій повністю перехресний і впорядкований за нововизначеними,
перевизначені та успадковані операції.
— Будь-які інші предмети

ВИКОРИСТАННЯ

Є два способи використання adabrowse:

1. Дзвінок adabrowse для вашої специфікації: adabrowse -f файл (і будь-які інші параметри, якщо потрібні, у
приватність -I якщо файл не знаходиться в поточному каталозі або залежить від інших модулів
чиї джерела не знаходяться в поточному каталозі!) Якщо немає файлу дерева для даного модуля
існує, adabrowse спробує створити його.

or

1. Згенеруйте файли дерева для специфікацій, які ви хочете обробити, за допомогою виклику gnatgcc -c -gnatc
-гнат файл (з відповідним -I варіанти, якщо потрібно.)

2. Дзвінок adabrowse для цих характеристик: adabrowse -f файл (і будь-які інші варіанти, якщо потрібно
[зокрема див -T!]).

adabrowse генерує файли HTML за замовчуванням у поточному каталозі.

adabrowse не має значення, чи файли дерева були створені зі специфікацій чи тіл:
оскільки деревовидний файл тіла завжди також містить інформацію про специфікацію, він може
працювати з будь-яким.

ВАРІАНТИ

-h, -?, -допомога, --допомога
Пише вичерпний довідковий текст.

-a, -всі, --все
Генерувати HTML не лише для одиниці, указаної в параметрі -f, але й для всіх
одиниці застосування, від яких це залежить семантично (перехідне замикання "with"es
і батьківські підрозділи).

Зауважте, що цей параметр обробляє лише блоки додатків у транзитиві
закриття, навіть якщо вказано параметр "-g"; він не обробляє жодних "з" вид
стандартна бібліотечна одиниця. Це також означає, що наведена одиниця є стандартною бібліотекою
одиниця, параметр "-all" не має ефекту. Така поведінка є навмисною: ви будете
зазвичай генерують HTML для стандартної бібліотеки один раз, обробляючи всі стандартні
блоки бібліотеки явно, і ви не хочете повторно генерувати HTML для цих блоків
кожного разу, коли одна з ваших програмних одиниць «з» є стандартною бібліотечною одиницею.

-c файл
Визначає файл конфігурації для генератора HTML. множинний -c варіанти можуть бути
даний; файли обробляються в заданому порядку та можуть перезаписати попередні конфігурації
налаштування

-f файл
Надає назву файлу (*.ads) специфікації для обробки. Ця назва файлу може містити a
шлях! Більше коментарів дивіться нижче. Тільки один -f може бути даний варіант.

-g Якщо встановлено, adabrowse також створює перехресні посилання на елементи з бібліотечних одиниць у
стандартні пакети та пакети часу виконання, за винятком елементів із імпліктного пакета
«Стандарт». Примітка: це також можна встановити за допомогою ключа файлу конфігурації
"Посилання_на_стандарт". Перемагає останнє визначення.

-G вихідні_формати...
Вкажіть вихідні формати adabrowse буде генерувати. The -G необхідно дотримуватися варіанту
одним або декількома назвами вихідних форматів, поданими як окремі аргументи. Розпізнаний вихід
імена форматів є HTML та XML (незалежно від регістру).

-i [файл]
Якщо встановлено, adabrowse створить індекс пакета, якщо він працює в "режимі введення файлу"
(див. нижче) або -всі параметр встановлено, і вихід не переходить до стандартного виводу.

Якщо вказано ім’я файлу, індекс записується в цей файл (або в stdout, якщо
ім'я файлу "-").

-є [файл]
Те саме, що -i, але генерує індекс із використанням відступів для дочірніх одиниць.

-l зробити adabrowse створювати перехресні посилання у вихідних даних HTML, використовуючи лише номер рядка.
Це те, що попередні версії adabrowse (до V2.13 включно) завжди робив.
Починаючи з версії 3.0, перехресні посилання будуються з урахуванням рядків і
номер колонки пункту. Використовуйте цей параметр, лише якщо у вас є HTML
документація, створена раніше adabrowse версій і чомусь не може повторно
створити цю документацію. Однак рекомендовано ніколи не використовувати це
опцію та відновити, можливо, вже існуючу документацію HTML.

Зауважте, що HTML, створений за допомогою -l несумісний із HTML, створеним без нього -l!
Крім того, HTML, згенерований adabrowse 3.0 і новіші версії сумісні зі згенерованим HTML
by adabrowse 2.13 і раніше, лише якщо -l надається варіант.

Використання цього параметра генерує попередження на stderr.

-o [файл]
Визначте назву вихідного файлу. Якщо не встановлено, вихідні дані спрямовуються до файлу з назвою
введення та суфікс . Сайтів. Якщо файл визначає каталог (тобто закінчується на "\" на
Windows або "/" в Unix), усі згенеровані HTML-файли будуть розміщені в ньому
каталог. Якщо ім'я файлу "-", вихід записується в stdout. Тільки один -o варіант
може бути дано.

Тире в назві файлу ("-") допускається, лише якщо існує точно один вихідний формат
зазначено. Якщо вказано кілька вихідних форматів (наприклад, XML і HTML),
вихідні дані не можуть переходити до stdout.

-p [файл]
As -i, але створює індекс підпрограми для всіх оброблених одиниць.

-приват, --приватний
Якщо дано, adabrowse також оброблятиме приватні частини пакетів і завдання або
захищені декларації. (За замовчуванням він цього не робить, але замінює приватний
частини коментарем "Реалізація визначена".)

-q Тихий режим: не видавати попередження або інформаційні повідомлення. Синонім до -w0.

-s URL Визначає URL-адресу таблиці стилів, яку використовуватиме згенерований файл HTML. Цей URL
має бути відносно кінцевого місця, куди ви розмістите файли HTML! Зауважте, що
a -s опцію можна перезаписати пізніше -c варіант, якщо файл конфігурації
визначає ключ "Style_Sheet".

-t [файл]
As -i, але створює глобальний індекс типу для всіх оброблених одиниць.

-версія, -- версія
Інформація про друковану версію adabrowse до stderr.

-wi Встановлює рівень попередження adabrowse. i може бути одним із наступних:
0 або e друкує лише повідомлення про помилки.
1, або w друкують попередження та помилки.
2, або i, або a вивести всі повідомлення.

-x Якщо встановлено, adabrowse ніколи не перезаписує існуючі файли HTML. (Може бути корисним у
поєднання з -a варіант.)

-X ім'я=значення
Визначте змінну середовища ім'я зі значенням значення. Значення замінює будь-яке
можливо вже існуюче визначення ім'я у середовищі системи для цього
зателефонувати до adabrowse. Нове визначення впливає на будь-який оброблений файл конфігурації
згодом, а також файл проекту (якщо є). The ім'я не повинно містити білого кольору
простір; якщо значення містить пробіли, цитуйте все визначення, як у -X"user=John
Лань". Між елементами може бути або не бути пробілу -X і змінна
визначення.

-I каталог
Визначте вихідні шляхи для ASIS. Така сама семантика, як і для GNAT. множинний -I варіанти можуть
бути наданим.

-T каталог
Визначте шляхи для ASIS для пошуку файлів дерева (*.adt). множинний -T варіанти можуть бути
дано.

Зауважте, що якщо ви вказуєте ім’я файлу -i варіант, що починається на букву "s",
ви повинні мати пробіл між параметром і назвою файлу, інакше буде
бути визнаним як a -є варіант. Крім того, якщо ім’я файлу починається з «-», не повинно бути
бути будь-яким пробілом між параметром і назвою файлу, якщо він є, adabrowse
вважатиме назву файлу наступним параметром і оброблятиме його як таке (параметри всі
починатися з "-"), а не як назва файлу.

Це ж застереження також стосується -p параметр, якщо ви бажаєте, щоб індекс підпрограми
перейдіть до файлу з назвою "rivate": там має бути порожнє, інакше все буде
бути визнаним як -приват варіант. (Правда, це досить патологічно
випадку, але це згадано тут для повноти.)

THE -f ВАРІАНТ

Команда -f варіант має три різні формати:

1. Якщо назва файлу "-" або "@-", adabrowse читає специфікації одиниць для обробки
від stdin, по одній одиниці на рядок, доки не зустрінеться EOF. Порожні рядки пропускаються. (Якщо
ви спробуєте це в інтерактивному режимі, вам доведеться самостійно подати сигнал EOF. В іншому випадку це може бути
корисно, якщо вхідні дані надходять із каналу, наприклад у "ls -1 *.ads | adabrowse -f- ...")

2. Якщо назва файлу починається з "@", adabrowse не розглядає це як специфікацію одиниці, а як
ім'я текстового файлу, з якого читаються назви одиниць, по одній одиниці на рядок. Порожні рядки
у файлі ігноруються.

3. Якщо ні те, ні інше не підходить, adabrowse використовує вказане ім'я файлу як специфікацію одиниці.

Перші два випадки називаються «режимом введення файлу». adabrowse. Файл може містити
порожні рядки та коментарі (починаючи з першого «#» у рядку й до
кінець рядка), які ігноруються. Зауважте, що на відміну від конфігураційних файлів, string
обробка пошуку початку коментаря не виконується, а також продовження рядка
допускається.

В усіх трьох випадках специфікація пристрою — це ім’я файлу, яке може містити шлях; можливий суфікс
ігнорується. Зауважте, що специфікація блоку — це ім’я файлу; іншими словами, ви даєте test-genабо
test-gen.ads, і ні Test.Gen. Причина полягає просто в тому, що для більшості сценаріїв оболонки
мовами легше працювати з назвами файлів, ніж масувати їх у назви модулів (наприклад,
заміною тире на крапку). Крім того, якщо у вас є закруглені імена файлів, простого немає
зв’язок між назвою файлу та назвою пристрою.

Якщо специфікація пристрою містить шлях, файл HTML для цього пристрою розміщується в цьому каталозі
якщо не перевизначено a -o варіант. Зауважте, що якщо специфікація пристрою містить шлях, ви найбільше
напевно також доведеться встановити a -T or -I варіант, якщо у вас немає ASIS
інформація, доступна безпосередньо (тобто файл дерева для пристрою в поточному каталозі;
але це не зовсім типово).

У режимі введення файлу -o варіант (якщо він взагалі наданий) може мати значення "-" (у цьому випадку всі
вихід надходить до stdout) або вказати каталог, але не повинен вказувати файл.

adabrowse передбачає подібну до GNAT схему іменування вихідних файлів і файлів HTML. Це також передбачає
що на файл припадає одна бібліотечна одиниця. Починаючи з V1.4, adabrowse може обробляти гофрований файл
імена в -f за умови, що він може знайти вихідний файл і має розширення .ади.
Якщо так, adabrowse замість цього відкриває та аналізує вихідний файл, щоб витягнути назву пристрою
одержуючи його безпосередньо з імені файлу. Зауважте, що створені файли завжди мають імена
на ім’я пристрою, а не на ім’я оригінального файлу: тобто, імена вихідних файлів ніколи не будуть
згорблений.

Згенеровані файли HTML завжди мають суфікс «.html» (а не «.htm»).

ІНДЕКС ПОКОЛІННЯ

Генерація індексу активна, коли adabrowse сказано обробити кілька одиниць, і вихід
не переходить до стандартного виводу (коли -О- варіант надано).

Існує кілька параметрів керування формуванням індексу:

-i or -є Вмикає генерацію індексу одиниці.
-p Вмикає генерацію індексу підпрограми.
-t Вмикає генерацію індексу типу.

Усі ці параметри приймають необов’язкову назву файлу як параметр. Якщо слідує ім’я файлу,
індекс буде записаний у цей файл (або в стандартний вихід, якщо ім’я файлу має значення "-"). Якщо
ім'я файлу не вказано, вибрано певне ім'я за замовчуванням.

Усі ці параметри фактично зберігаються лише з причин зворотної сумісності. Щодо
Версія 4.0, індекси визначаються переважно через записи файлу конфігурації, а не команди
лінія. Щоб не зламати існуючі сценарії, використовуйте попередні параметри командного рядка
adabrowse версії, ці параметри все ще доступні.

adabrowse припускає, що він оброблятиме кілька одиниць у таких випадках:
· У режимі введення файлу (-f @ім'я файлу or -f-).
· При використанні файлу проекту (-P ім'я_файлу_проекту).
· Коли -всі надається варіант.

Якщо ім’я файлу не вказано або він не містить шляху, це залежить від налаштування
інші варіанти розміщення індексу:
· У режимі введення файлу, якщо a -o надано параметр, він має вказати каталог. Весь HTML
файли, включно з індексом, буде розміщено в цьому каталозі.
· Якщо ні -o задано параметр, але перша специфікація блоку містить шлях, індекс ставиться
у каталог, позначений цим шляхом.
· Якщо не в режимі введення файлу, але було надано параметр -all, the -o варіант може
вкажіть ім'я файлу. Індекс поміщається в каталог, позначений частиною шляху
цього імені файлу (поточний каталог, якщо ім’я файлу не містить шляху).
· Якщо використовується файл проекту, індекси записуються в каталог ADABROWSE_OUTPUT.
· В іншому випадку цей індекс буде розміщено в поточному каталозі.

Якщо вказано ім’я файлу, що містить шлях, індекс буде розміщено в цьому файлі в
заданий каталог. Якщо назва файлу містить лише шлях, adabrowse буде використовувати цей шлях і
створити індекс під назвою "index.html" у вказаному каталозі.

Якщо -x задано параметр (заборона перезапису існуючих файлів HTML), і файл існує
вже в тому місці, де adabrowse хоче розмістити індекс, індекс не буде створено
та adabrowse винесе попередження. Він також попереджатиме, якщо не зможе створити індекс для будь-якого
інші причини, але в іншому випадку продовжить обробку.

Використовуйте adabrowse онлайн за допомогою сервісів onworks.net