Как посмотреть и редактировать исходный код open source программы

Используя и изучая приложения с открытым исходным кодом, вы можете научиться, как создавать хорошие приложения самостоятельно.


Ниже перечислены лучшие проекты под Android с открытым исходным кодом. Благодаря им вы сможете узнать массу отличных практик для разработки под Android.

1. Android-приложение с MVP архитектурой

MVP с использованием .

2. Android-приложение с MVVM архитектурой

Этот репозиторий содержит приложение, которое реализует архитектуру MVVM с использованием Dagger2, GreenDao, RxJava2, Fast-Android-Networking и PlaceholderView .

3. Google I/O Android-приложение

Google I/O - это конференция разработчиков, которая проводится каждый год. На ней представлены сотни демонстраций технологий от разработчиков.


Этот проект - Android-приложение для конференции. Приложение поддерживает устройства под управлением Android 5.0+ и оптимизировано для телефонов и планшетов всех форм и размеров.


4. Чертежи архитектуры Google Android

Платформа Android обладает большой гибкостью, когда организует и архивирует приложение. Эта свобода может привести к приложениям с большими классами. Это может затруднить тестирование, поддержку и расширение.


Архитектура Android Blueprint предназначена для демонстрации возможных способов помочь в решении этих проблем. Этот проект показывает одно и то же приложение, реализованное много раз с использованием различных архитектурных концепций и инструментов.


Вы можете использовать эти образцы как отправную точку для создания собственных приложений. Здесь основное внимание уделяется структуре кода, архитектуре, тестированию. Однако имейте в виду, что существует множество способов создания приложений с этими архитектурами и инструментами. Сосредоточьтесь на своих собственных приоритетах и не слишком увлекайтесь тем, что можно считать каноническими примерами.

5. Telegram

Приложение под Android, которое способно вдохновить своим дизайном, благодаря отличной реализации material design.

7. Wire

Это приложение чата полно картин, фильмов, GIF, музыки, эскизов и других форм мультимедиа. Также оно всегда обеспечивает безопасное сквозное шифрование.


8. Андроид-приложение ribot

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

10. PocketHub

GitHub отказался поддерживать приложение, поэтому оно было выпущено "в люди" и поддерживается как публичный проект. Сейчас общество активно работают над переизданием этого приложения в Play Маркет. Это приложение станет духовным преемником оригинального приложения.

11. Простое андроид-приложение с MVP

Очень простое приложение, показывающее, как реализовать архитектуру MVP.

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

Программный код - это набор слов и символов языка программирования.

Алфавит - это полный набор букв, цифр и символов, принятых в языке для обозначения данных и действий над ними.

Алфавит языка Visual Basic включает следующий набор символов :

Прописные (A - Z) и строчные (а - z) буквы латинского алфавита;

Цифры от 0 до 9;

Знаки арифметических операций (в порядке возрастания приоритета): +, -, *, /, |, ^;

Знаки операций отношения: =, <, >.

Знаки препинания и разделители: ,  . : ; ();

В алфавит языка входят также зарезервированные слова, которые не могут быть использованы в качестве имен переменных или процедур. Примеры зарезервированных слов: Dim, Sub, Integer и т.д. По умолчанию для выделения ключевых слов в окне редактирования кода Visual Basic используют шрифт синего цвета.

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

Окно программного кода

Программный код записывается в окне кода. Такое окно имеется у каждой формы.

Открыть окно кода:

1 способ - в окне Проводник Проекта щелкнуть правой кнопкой по нужной форме и в открывшемся меню выбрать Показать код.

Примечание : окно кода может быть и не связано с формой. Отдельное окно кода называется Модуль . Модули в окне Проводник проекта сгруппированы в группу Модули . Для открытия окна с кодом модуля нужно в окне Проводник проекта дважды щелкнуть по имени модуля.

2 способ - дважды щелкнуть по элементу управления на форме или по самой форме в окне формы.

Примечание : при этом не только открывается окно кода, но и создается процедура обработки события (см. ниже).

Структура окна кода:

Рис. 7. Окно программного кода.

    Список элементов управления

    Список событий элементов управления

    Процедура (код)

Процедуры

Поскольку при открытии холодильника загорается лампа, а при открытии крана - вытекает вода, то можно сказать, что при возникновении события открытие холодильника выполняется одна процедура, а событие открытие крана вызывает другую процедуру. Аналогично и программный код состоит из отдельных процедур, каждая из которых выполняет свои определенные для нее действия, например, одна процедура зажигает лампу, другая включает (накачивает) воду.

Visual Basic - процедурный программирования язык. Это означает, что в нем можно создавать блоки программного кода, на которые затем можно ссылаться по имени. После того как блок кода получит имя, он может быть вызван и выполнен. Это похоже на программу в программе. Маленькие программы, "живущие" в больших программах, называются функциями, если они возвращают какое-либо зна­чение, и подпрограммами, если они значений не возвращают.

Подпрограммы и функции делают процесс программирования более простым и быстрым, а создаваемый код - более надежным. Создание собственных подпрограмм и функций - первый шаг к разработке инкапсулированного и повторно используемого кода. Под инкапсуляцией следует понимать сокрытие реализации свойств и мето­дов объекта за его внешним интерфейсом.

Процедура (подпрограмма) - это обособленный фрагмент программного кода, с помощью которого решается обычно небольшая задача, это логически построенный, небольшойпрограммный блок, на которые делится вся программа.

Если процедура может выполняться только внутри данного программного блока (например, только в этой форме), и её нельзя вызвать из другого программного блока, то такая процедура является локальной. Локальная процедура задается с помощью ключевого слова Private Sub.

Если процедуру можно вызвать из других программных блоков (например из другой формы), то такая процедура является глобальной. Глобальная процедура задается с помощью ключевого слова Public Sub.

По умолчанию, если перед ключевым словом Sub, отсутствует ключевое слово, то эта глобальная процедура.

Процедуры бывают:

    Процедуры обработки событий . Выполняются при возникновении какого-либо события в каком-либо элементе управления (или форме). Событийная процедура всегда связана с каким-то объектом. Чтобы вызвать событийную процедуру объекта, достаточно по этому объекту сделать двойной левый щелчок.

    Произвольные процедуры . Она не связаны с событиями и могут быть вызваны из любой другой процедуры и выполнены в любое время. Если в программе во всех формах встречается один и тот же программный блок, то его можно записать только один раз и в одном месте, в виде глобальной общей программы. Запуск общей программы не связана с объектом и с событием, а происходит, когда к нему обращаются из других программных блоков. Вызов общей процедуры из той же формы: ИмяПроцедуры (СписокПараметров) . Вызов общей процедуры из другой формы: ОБЪЕКТ. ИмяПроцедуры (СписокПараметров) . Общая процедура бывает и локальной Private и глобальной Public

Структура процедуры

Процедура состоит из следующих элементов:

    Заголовок процедуры - отмечает начало процедуры, ее тип, назначение (событие).

Пример заголовка процедуры, которая выполняется при щелчке мышью по кнопке с именем Command1.

    Слово Private означает - закрытая, то есть процедура принадлежит только данной форме или модулю и не может быть использована другими контейнерами (формами, модулями). Если это слово опустить, то процедура будет открыта для других контейнеров.

    Sub - процедура.

Примечание : кроме процедур бывают функции - function. Функции не связаны с событиями и дополнительно могут возвращать результат своей работы (вычислений).

    Элемент управления (или имя формы): здесь указывается точное имя элемента, хранящееся в свойстве Name.

    Событие - наименование события. Вот некоторые события:

    Click - щелчок мышью;

    DblClick - двойной щелчок мышью;

    KeyPress - нажатие клавиши;

    UnLoad - выгрузка формы (при закрытии формы, завершении программы);

    Activate - активизация формы (при щелчке по форме, когда ее заголовок подсвечивается);

    Deactivate - деактивизация формы (при щелчке по другой форме).

    Initialize - при создании объекта типа форма.

    Resize - при изменении размера формы

    Terminate - в момент удаления формы

    Аргументы - это исходные данные, передаваемые процедуре для обработки.

У произвольных процедур заголовок следующий:

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

    Окончание процедуры - заканчивает программный код процедуры: End Sub

Примечание : у функций: End Function

    Тело процедуры - это строки между заголовком и окончанием. Их количество неограниченно. Строки содержат предписания, которые должны выполниться при вызове процедуры (возникновении события).

Подпрограмма (Sub ) - представляет собой процедуру, выполняющую про­граммный код в пределах своего блока и не возвращающую значения. Синтаксис про­стой подпрограммы таков:

( Private | Public ) Sub SubMain ()

..строки кода End Sub

Область видимости подпрограммы;

Sub -тип процедуры (а именно - подпрограмма);

subMain имя, присваиваемое подпрограмме;

End Sub -окончание блока кода подпрограммы.

Создание процедуры

Для создания процедуры выполните следующее:

    1 способ - дважды щелкните по нужному элементу управления или форме. Откроется окно кода, а в нем появится заголовок и окончание процедуры. Если необходимо другое событие, то его выбирают с помощью списка в верхнем правом углу окна кода.

    2 способ - откройте окно кода, выполните Инструменты → Добавить процедуру → укажите имя и параметры процедуры → Ok.

    3 способ - откройте окно кода и введите нужные строки с клавиатуры.

В результате должно получиться:

Private Sub Command1_Click()

Вызов процедур на исполнение

    Чтобы выполнилась процедура обработки события, это событие должно произойти.

    Для выполнения произвольной процедуры в теле другой процедуры указывают имя этой процедуры.

Private Sub Command1_Click()

Здесь при нажатии на кнопку Command1 возникает событие Click (щелчок мышью) и вызывается и выполняется процедура Kvadrat.

Код процедуры выполняется построчно и сверху вниз.

Функция (Function ) - это процедура, которая выполняет строки своего кода и возвращает некоторое значение. Синтаксис простой функции таков:

Function FunctionName() As Datatype

... строки кода

FunctionName = ReturnValue End Function

Область ви­димости функции;

Function - ключевое слово Visual Basic, указывающее на то, что это именно функция;

FunctionName () - имя, присваиваемое функции;

AS - ключевое слово Visual Basic, предваряющее назначение типа данных;

DataType тип данных возвращаемого значения;

ReturnValue значение, которое должно быть при­своено имени функции (это очень важный момент!);

End Function -конец данного блока кода.

Если вы собираетесь подраться в разработку ПО, то лучше всего будет пойти путем открытого кода. Таким образом, люди смогут не просто просматривать исходный код вашего приложения и предлагать от себя исправления, но и вы также сможете знакомиться с открытым кодом других приложений, в качестве отправной точки или источника вдохновения.

Несмотря на то, что открытый исходный код абсолютно точно можно назвать хорошим выбором, вам также надо будет инвестировать в «правильное» сообщество. Мы расскажем про сервис, который представляет собой один из лучших подобных ресурсов не только из-за огромной численности пользователей, но также и благодаря свойствам, которые предлагает система. Если вы найдете любую программу с открытым исходным кодом на GitHub, вам будет представлено несколько опций, включая просмотр, редактирование и создание форка (использование кодовой базы в качестве старта для другого – прим. Wikipedia).

Создаем аккаунт

Перед тем, как начать пользоваться GitHub, следует создать аккаунт. Это можно сделать бесплатно, после чего у вас будет доступ ко множеству опций, включая форкинг. Он также предлагает различные уровни членства, кроме бесплатного (но для личного пользования вам с лихвой хватит и бесплатного аккаунта).

Просматриваем программу

Как только вы создадите аккаунт, вы сразу же можете приступать к рассмотрению приложений с открытым исходным кодом. Здесь вы можете видеть страницы приложений, включая папки и файлы, присущие приложению, сетевую графу, список запросов, проблемные места, wiki-страницу и другие графы. Очевидно, если вам небходимо будет увидеть код из файлов, кликните по ним, и перед вами предстанет полноценный исходный код. В зависимости от представленного кода, вам могут понадобиться фоновые знания различных языков программирования, на одно из которых может быть написана программа, будь то Java, C++, Python или какой-нибудь еще. Если вам до сих пор что-то не понятно, взгляните на представленный ниже скриншот:

Форкинг проекта

Редактирование кода требует несколько дополнительных этапов. Если вы хотите скопировать код без официального форкинга на GitHub, то скачайте файлы, а затем отредактировать их локально. Тем не менее, если вы хотите взять доступный код, и на его основе создать собственный проект, вам следует сделать форкинг. Форкинг можно сделать посредством зарегистрированного аккаунта – нажмите «Fork» на странице, как показано на скриншоте. Следующие инструкции предназначены для пользователей Linux, которым нужно установить пакет Git для дальнейшей дистрибуции.

Если вы хотите получить файлы из репозитория на свой компьютер, вам нужно запустить команду git clone, заменив username на ваш логин в GitHub, а project_name на название приложения, с которого вы реализуете форкинг. Запустите эту команду в папке, которая должна содержать все проекты, так как каждая команда git clone создает новую папку внутри той, с которой вы работаете. Это еще один способ скачать файлы, так как для этого не требуется авторизация. Теперь вы можете изменить файлы по собственному усмотрению, используя любой текстовый редактор или IDE. Что касается пользователей Linux, я порекомендовал бы Eclipse или Geany, так как они представляют собой отличные редакторы для программирования – Eclipse больше укомплектован функциями, а Geany более удобный. Пользователи Windows также могут воспользоваться родным GitHub-клиентом.

Загружаем изменения

Как только вы закончите вносить правки, вы можете загрузить обновленные файлы обратно на Github посредством команды git push origin master, находясь внутри папки приложения. Это позволит перенести изменения в «источник» (на основе которого вы делаете личный), и в главную ветвь (стандартное расположение исходного кода).

Следим за потоком

Если вы хотели бы и дальше следить за развитием проекта, с которого вы использовали основу, то вам нужно добавить кое-что, что принято называть дополнительным удаленным. Это просто еще один ключ, который вы можете использовать, находясь внутри папки приложения. Чтобы создать новый удаленный проект, запустите команду git remote add upstream, где username нужно заменить на логин из исходног, а project_name нужно заменить на название его проекта.

Если вы заметили, что главный проект обновляется, и вы хотели бы принять эти правки, то нужно запустить команду git pull upstream после того, как будет создан дополнительный удаленный, и GitHub скачает и внесет изменения из основного в файлы вашего. Если все будет работать после запуска, вы можете сразу же запустить команду git push origin master, чтобы извлечь обновления для вашего собственного проекта.

Предлагаем редактирование

Если вы хотели бы предложить нечто от себя для основного проекта, то лучше всего сначала внести правки в ваш (либо в ваше ответвление от основного, но станет возможным только по согласованию первичного автора). Как только вы редактируйте ваш репозиторий, вы можете подтвердить предложение. Это действие уведомит первичного автора программы о том, что вы хотели бы предложить какие-то изменения, которые можно было бы внести в основную программу. Довольно-таки сильно распространены случаи, когда разработчики предлагают собственные отличия первичному автору, и даже если он не принимает эти изменения, то как минимум поблагодарит вас за то, что вы взяли его код как основу для собственного приложения.

В завершение

GitHub – это невероятный инструмент с большим объемом открытого кода проектов, которыми уже пользуются многие разработчики. В то время, как этот сервис использует Git-утилиту, которую каждый может настроить на собственных серверах, сервис также включает в себя отличное сообщество разработчиков – неотъемлемую и важную часть открытого кода. Данное введение в курс дела должно помочь вам познакомиться с основами. Если вам хочется узнать больше о самом процессе разработки кода, вы можете взглянуть статью, в которой описываются лучшие сайты, помогающие изучить C++.

Использовали ли вы когда-нибудь этот сервис? О какой функции, как вы считаете, следует рассказывать людям в первую очередь? Пожалуйста, расскажите в комментариях!

(Руководство разработчика по микроконтроллерам семейства HCS08)

В Примере 12.1 мы рассмотрим программный код, который позволяет записать и стереть собственные данные во флэш-памяти. Такие действия бывают необходимы, если пользователь какого-либо устройства производит дополнительную настройку этого устройства и желает, чтобы выбранная конфигурация сохранилась после отключения питания.

Ранее нами было отмечено, что МК семейства HCS08 не позволяют выполнять операции стирания и программирования флэш-памяти, исполняя программу управления этими режимами также из флэш-памяти. Обязательно следует сначала переписать программный код, отвечающий за операции стирания и программирования, в оперативную память, а затем запустить этот код на исполнение. В процессе стирания и программирования к модулю флэш-памяти будет приложено повышенное напряжение. Однако это не приведет к срыву работы программы, поскольку в данный момент времени она будет исполняться из ОЗУ.

Компания NXP разработала набор утилит на ассемблере, который упрощает создание собственного программного кода для программирования флэш-памяти под управлением рабочей программы устройства. Эти утилиты размещены в файле doonstack.asm . Этот файл следует включить в проект, как показано на Рис. 12.3 .

Рис. 12.3. Окно проекта с включенным файлом doonstack.asm .

Содержимое файла doonstack.asm представлено ниже. Приведен оригинальный текст используемого программного кода, поэтому комментарии переводу не подлежат.


;* This stationery is meant to serve as the framework for a *
;* user application. For a more comprehensive program that *
;* demonstrates the more advanced functionality of this *
;* processor, please see the demonstration applications *
;* located in the examples subdirectory of the *
;* Metrowerks Codewarrior for the HC08 Program directory *
;**************************************************************
; export symbols
XDEF DoOnStack
XDEF FlashErase
XDEF FlashProg
; we use export "Entry" as symbol. This allows us to
; reference "Entry" either in the linker .prm file
; or from C/C++ later on

; include derivative specific macros
Include "MC9S08GB60.inc"

Две следующие строки следует раскомментировать и назначить желаемые значения.

;mPageErase equ $40
;mByteProg equ $20
mFACCERR equ $10
mFPVIOL equ $20
mFCBEF equ $80
; variable/data section
MY_ZEROPAGE: SECTION SHORT
; Insert here your data definition. For demonstration, temp_byte is used.
; temp_byte ds.b 1
; code section
MyCode: SECTION
;**************************************************************
; this assembly routine is called the C/C++ application
DoOnStack: pshx
pshh ;save pointer to flash
psha ;save command on stack
ldhx #SpSubEnd ;point at last byte to move to stack;
SpMoveLoop: lda ,x ;read from flash
psha ;move onto stack
aix #-1 ;next byte to move
cphx #SpSub-1 ;past end?
bne SpMoveLoop ;loop till whole sub on stack
tsx ;point to sub on stack
tpa ;move CCR to A for testing
and #$08 ;check the I mask
bne I_set ;skip if I already set
sei ;block interrupts while FLASH busy
lda SpSubSize+6,sp ;preload data for command
cli ;ok to clear I mask now
bra I_cont ;continue to stack de-allocation
I_set: lda SpSubSize+6,sp ;preload data for command
jsr ,x ;execute the sub on the stack
I_cont: ais #SpSubSize+3 ;deallocate sub body + H:X + command
;H:X flash pointer OK from SpSub
lsla ;A=00 & Z=1 unless PVIOL or ACCERR
rts ;to flash where DoOnStack was called
;**************************************************************
SpSub: ldhx LOW(SpSubSize+4),sp ;get flash address from stack
sta 0,x ;write to flash; latch addr and data
lda SpSubSize+3,sp ;get flash command
sta FCMD ;write the flash command
lda #mFCBEF ;mask to initiate command
sta FSTAT ; register command
nop ;[p] want min 4~ from w cycle to r
ChkDone: lda FSTAT ; so FCCF is valid
lsla ;FCCF now in MSB
bpl ChkDone ;loop if FCCF = 0
SpSubEnd: rts ;back into DoOnStack in flash
SpSubSize: equ (*-SpSub)
;**************************************************************
FlashErase: psha ;adjust sp for DoOnStack entry

lda #mPageErase ;mask pattern for page erase command
bsr DoOnStack ;finish command from stack-based sub
rts
;**************************************************************
FlashProg: psha ;temporarily save entry data
lda #(mFPVIOL+mFACCERR) ;mask
sta FSTAT ;abort any command and clear errors
lda #mByteProg ;mask pattern for byte prog command
bsr DoOnStack ;execute prog code from stack RAM
ais #1 ;deallocate data location from stack
rts
;**************************************************************

Также в тексте программного кода на С необходимо директивой #include подключить файл doonstack.h , текст которого представлен ниже.


/* */
/* Project Name: doonstack.h */
/* Last modified: 04/11/2004 */
/* By: r60817 */
/* */
/* */
/**********************************************************************/
/* */
/* Description: MC9S08GB60_FLASH_DOONSTACK - demo */
/* */
/* */
/* Documentation: MC9S08GB60/D Rev. 2.2 */
/* HCS08RMv1/D Rev. 1(4.8FLASH Application Examples) */
/* */
/* This software is classified as Engineering Sample Software. */
/* */
/**********************************************************************/
/* */
/* Services performed by FREESCALE in this matter are performed AS IS */
/* and without any warranty. CUSTOMER retains the final decision */
/* relative to the total design and functionality of the end product. */
/* FREESCALE neither guarantees nor will be held liable by CUSTOMER */
/* for the success of this project. FREESCALE DISCLAIMS ALL */
/* WARRANTIES, EXPRESSED, IMPLIED OR STATUTORY INCLUDING, BUT NOT */
/* LIMITED TO, IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A */
/* PARTICULAR PURPOSE ON ANY HARDWARE, SOFTWARE ORE ADVISE SUPPLIED */
/* TO THE PROJECT BY FREESCALE, AND OR NAY PRODUCT RESULTING FROM */
/* FREESCALE SERVICES . IN NO EVENT SHALL FREESCALE BE LIABLE FOR */
/* INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT. */
/* */
/* CUSTOMER agrees to hold FREESCALE harmless against any and all */
/* claims demands or actions by anyone on account of any damage, or */
/* injury, whether commercial, contractual, or tortuous, rising */
/* directly or indirectly as a result of the advise or assistance */
/* supplied CUSTOMER in connection with product, services or goods */
/* supplied under this Agreement. */
/* */
/**********************************************************************/
/*
- this file API between main.c and doonstack.asm
*/
#ifndef _doonstack
#define _doonstack
#ifdef __cplusplus
extern "C" { /* our assembly functions have C calling convention */
#endif
void DoOnStack(void); /* prototype for DoOnStack routine */
void FlashErase(unsigned char *); /* prototype for FlashErase routine */
/* Page Erase command */
void FlashProg(unsigned char *, unsigned char); /* prototype for FlashProg routine */
/* Byte Program command */
#ifdef __cplusplus
}
#endif

#endif /* _doonstack */
/**********************************************************************/

В нашем примере для записи энергонезависимых данных резервируется блок в 512 байт. Такой размер блока выбран потому, что это минимально разрешенный для стирания объем ячеек флэш-памяти в микроконтроллере MC9S08QG8. Выбранный блок будет располагаться в начале адресного пространства резидентной флэш-памяти МК: от 0xE000 до 0xE1FF. Программный код будет начинаться с адреса 0xE200 и может занимать адресное пространство вплоть до 0xFFFF.

Для того чтобы реализовать задуманное размещение кодов данных и программы, следует изменить установки компоновщика в файле project.prm .

В стандартном проекте была запись:


ROM = READ_ONLY 0xE000 TO 0xFFAD;

Ее следует заменить:

SEGMENTS /* Here all RAM/ROM areas of the device are listed */
ROM = READ_ONLY 0xE200 TO 0xFFAD;

В нашем примере также использован режим защиты от записи области программного кода, т.е. адресного пространства от 0xF200 до 0xFFFF. На Рис. 12. 4 показан процесс формирования кода для регистра FPROT, который обеспечивает защиту адресного пространства 0xF200...0xFFFF от случайного стирания/записи. Семь старших битов последнего адреса 0xF1FF незащищенного адресного пространства должны быть записаны в регистр FPROT.

Адрес A15 A14 A13 A12 A11 A10 A9 A8 A7 A6 A5 A4 A3 A2 A1 A0
0xE1FF 1 1 1 0 0 0 0 1 1 1 1 1 1 1 1 1
FPROT FPS7 FPS6 FPS5 FPS4 FPS3 FPS2 FPS1 FPDIS
0xE0 1 1 1 0 0 0 0 0

Рис. 12.4. Формирование записи кода зашиты для регистра FPROT.

Пример 12.1. Операции с энергонезависимыми данными во флэш-памяти

// Демонстрационная плата DEMO9S08QG8
// стирание/запись/чтение резидентной флэш-памяти
#include /* for EnableInterrupts macro */
#include "derivative.h" /* include peripheral declarations */
#include "hcs08.h" /* Это наш файл с объявлениями! */
#include "doonstack.h"
#define BUSCLK 8000000
#define vFCDIV (BUSCLK/200000-1)
char fdata, operation;
unsigned int faddress;
// Назначается область защищенных от записи адресов: от 0xE200 до 0xFFFF
const byte NVPROT_INIT @0x0000FFBD = 0xE0;
// Инициализация МК
void mcu_init(void)
{
SOPT1 = bBKGDPE; // Разрешение функции линии отладки BKGD
ICSSC = NV_FTRIM; // Записать значение подстройки FTRIM
ICSTRM = NV_ICSTRM; // Записать значение подстройки TRIM
ICSC2 = 0; // ICSOUT = DCOOUT / 1
// BUSCLK = 8 МГц
FCDIV = vFCDIV; // Записать значение кода делителя для частоты FCLK
// (FCLK = 200 кГц)
}
#pragma inline
// Функция чтения байта из ячейки памяти с заданным адресом
char flash_read(unsigned int address)
{
unsigned char *pointer;
pointer = (char*) address;
return (*pointer);
}
// Функция записи байта в ячейку памяти с заданным адресом
char flash_write(unsigned int address, unsigned char data)
{
unsigned char *pointer;
pointer = (char*) address;
FlashProg(pointer,data); // Вызов функции программирования флэш-памяти
if (FSTAT_FACCERR) data=1; else data=0;
if (FSTAT_FPVIOL) data|=2;
return(data);
}
// Функция стирания заданного блока в области флэш-памяти
unsigned char flash_sector_erase(unsigned int address)
{
unsigned char *pointer, res;
pointer = (char*) address;
FlashErase(pointer);
if (FSTAT_FACCERR) res=1; else res=0;
if (FSTAT_FPVIOL) res|=2;
return(res);
}
void main(void)
{
mcu_init();
fdata = 0;
faddress = 0xE000;
operation = 0;
while (1)
{
switch (operation)
{
case 1: // Стирание блока
fdata = flash_sector_erase(faddress);
operation = 0;
break;
case 2: // Запись байта
fdata = flash_write(faddress,fdata);
operation = 0;
break;
case 3: // Чтение байта
fdata = flash_read(faddress);
operation = 0;
break;
}
}
}

Рассмотрим методику тестирования программного кода Примера 12.1. Для этого в окно отладчика Data добавим три переменные: faddress , fdata , operation . Также установим для окна режим периодического обновления, например, через 200 мс.

Перед запуском на исполнение программного кода запишите в переменную faddress адрес для записи, а в переменную fdata — байт данных для записи. Далее в переменную operation запишите код 0x02. После запуска программного кода примера начнется запись байта данных в выбранную ячейку флэш-памяти. Обратите внимание, что выбранная ячейка должна находиться в стертом состоянии, т.е. в ней должен быть код 0xFF.

Для того чтобы стереть блок памяти 0xE00...0xE1FF, запишите в faddress любой адрес из указанного диапазона и установите переменную operation в 1. Далее запустите код снова на исполнение.

Прочитать данные из флэш-памяти тоже просто. Для этого запишите в переменную faddress код адреса, в переменную operation — код 0x03. Содержимое выбранной ячейки флэш-памяти отобразится в переменной fdata после исполнения программного кода.

Обратите внимание, что функции flash_write() и flash_sector_erase() возвращают переменную типа chare с кодом ошибки при выполнении действия: 0 — не было ошибки, 0x02 — была ошибка доступа, 0x04 — была попытка стирания/записи защищенного адресного пространства. Обе упомянутые функции требуют для своего исполнения около 35 байт стековой памяти. Если реальная область стека окажется меньше, то произойдет фатальная ошибка. Восстановить работоспособность программы можно будет только сбросом МК.

Для того чтобы посмотреть в отладчике изменения флэш-памяти, необходимо внести некоторые изменения в конфигурацию отладчика. Следуя установкам по умолчанию, отладчик считывает область флэш-памяти МК только один раз после запуска сессии отладки. Для изменения конфигурации выберите в главном меню отладчика опцию MultilinkCyclonPro > Debug Memory Map . Откроется окно, показанное на Рис. 12.5 , а . Выберите в этом окне memory block 3 и нажмите кнопку Modify/Details . В новом окне, показанном на Рис. 12.5 , б , выберите отмеченную опцию. Она позволит отладчику периодически обновлять окно памяти.

Рис. 12.5. Изменение конфигурации отладчика для периодического обновления содержимого окна памяти.

Любая программа или онлайн-сервисы, например, Word, Microsoft Windows, WhatsApp или же браузер, которые ежедневно запускают сотни миллионов человек, так или иначе, состоят из особых инструкций. Или специального программного кода, который понятен машине, говорит, что ей делать или, наоборот, не делать. Или как правильно реагировать на действия пользователя. Что такое программный код, будет разобрано в этой статье.

Описание

Программный код программы — это текст, выполненный на особом языке, понятном машине. Он может выполняться непосредственно по тексту с помощью интерпретатора или транслироваться в особый вид с помощью компилятора.

Исходный код программы может состоять из нескольких файлов. При этом все они должны быть одинакового формата. Текст программы, содержащейся в них, должен быть написан на одном и том же языке. Правда, могут встречаться и исключения. Например, в веб-разработке в файле страницы могут содержаться несколько различных языков программирования и стандартов. В зависимости от сложности проекта, могут присутствовать такие языки и технологии, как PHP, HTML, и другие.

Сложные программные комплексы при сборке могут потребовать большого количества файлов, которое может исчисляться целыми сотнями. Для совместной работы над такими большими проектами программисты очень часто используют системы контроля версий. Они позволяют одновременно работать с несколькими экземплярами исходного кода, который на определённом этапе разработки можно соединить в один общий.

Качество кода

Компьютер не способен понять, как написан код для него, плохо или хорошо. Если он будет работоспособен и не содержит ошибок, то машина запустит его в любом случае. Плохой код может усложнить задачи сопровождения программного обеспечения. Особенно актуально это для больших проектов. Обычно качественный код характеризуется несколькими параметрами:

  • Читаемость кода. Одного взгляда на него должно хватать, чтобы обобщенно понять, что реализуется участком кода.
  • Присутствие понятных и ёмких комментариев. Данный параметр очень сильно влияет на читаемость, легкость в отладке, тестирование поддержки и устранение ошибок программного кода.
  • Низкая сложность.
  • Оптимизация кода. Организовать его стоит таким образом, чтобы программа использовала как можно меньше системных ресурсов, таких как память, время процессора и пространство жёсткого диска.
  • Отсутствие мусора. То есть не используемых переменных или блоков кода, в которой никогда не заходит управление программой.

Вредоносный программный код

Помимо полезных программ, существуют такие, которые могут нанести вред системе или даже оборудованию. Как правило, пишется такой код людьми, которые заинтересованы в какой-либо выгоде от происходящего процесса. Например, программы, которые могут похищать личные данные с компьютеров пользователей. Ими могут быть номера платёжных карт, паспортные данные, или какая-либо другая конфиденциальная информация. Другие могут просто оказывать влияние на работу системы, тем самым вызывая сбои и мешая полноценной функциональности.

Джефф Вогел - программист с большим опытом - поделился несколькими советами для того, чтобы научить начинающих разработчиков правилам хорошего кода.

В частности, он предлагает всегда комментировать свой программный код. Что такое комментарий? Это понятное и краткое описание того, что происходит в данной строке кода или функции. Дело в том, что разработка определённой программы может затянуться на месяц или вообще приостановиться на некоторое время. Вернувшись к работе над проектом через пару месяцев, даже опытному программисту будет сложно разобраться в своей же программе. Но подробные комментарии смогут восстановить цепочку событий и поведение кода.

Далее он рекомендует использовать в программе глобальные переменные как можно чаще. Это объясняется тем, что при изменении программного кода, придётся корректировать значение переменной всего лишь в одном месте. При этом все использующие значение функции или процедуры сразу об этом узнают и будут производить операции уже с новыми данными.

Имена переменных и выявление ошибок

Правильное название переменных также поможет значительно сократить время на изучение исходного кода программы, даже если код написан собственными руками. То есть хорошим кодом считается такой текст, где переменные и функции имеют имена, по которым можно понять, что именно они делают или хранят. При этом нужно стараться не использовать длинных имён переменных.

Очень важно уделять большое внимание своевременному устранению ошибок. Что такое программный код, который исполняется идеально? Это код, в котором нет ошибок. То есть любое ветвление цикла или изменение переменной, или вовсе какие-либо непредвиденные действия пользователя, всегда приведут к ожидаемому результату. Это достигается за счёт тестирования готового по несколько раз.

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

Оптимизация имеет колоссальное значение для написания работоспособной программы, которая будет экономно использовать ресурсы компьютера и при этом не допускать ошибок выполнения программного кода. Что такое оптимизированная программа? Это продукт, который способен выполнять весь заявленный функционал, ведя себя при этом "тихо" и экономно.

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

Заключение

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

  • Сергей Савенков

    какой то “куцый” обзор… как будто спешили куда то