Blame programming-guidelines/cs/preconditions.page

Packit 1470ea
Packit 1470ea
<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" xmlns:xi="http://www.w3.org/2003/XInclude" type="topic" id="preconditions" xml:lang="cs">
Packit 1470ea
Packit 1470ea
  <info>
Packit 1470ea
    <link type="guide" xref="index#specific-how-tos"/>
Packit 1470ea
Packit 1470ea
    <credit type="author copyright">
Packit 1470ea
      <name>Philip Withnall</name>
Packit 1470ea
      <email its:translate="no">philip.withnall@collabora.co.uk</email>
Packit 1470ea
      <years>2015</years>
Packit 1470ea
    </credit>
Packit 1470ea
Packit 1470ea
    <include xmlns="http://www.w3.org/2001/XInclude" href="cc-by-sa-3-0.xml"/>
Packit 1470ea
Packit 1470ea
    <desc>Kontraktové programování s kontrolami na vstupu a výstupu funkcí</desc>
Packit 1470ea
  </info>
Packit 1470ea
Packit 1470ea
  <title>Úvodní a závěrečné podmínky</title>
Packit 1470ea
Packit 1470ea
  <section id="pre-and-post-conditions">
Packit 1470ea
    <title>Úvodní a závěrečné podmínky</title>
Packit 1470ea
Packit 1470ea
    

Důležitou zásadou bezpečného kódu je, že se nesprávná data nebudou programem dále šířit – čím dále se vadný vstup může dostat, tím větší částí kódu projde a potenciálně se zvyšuje možnost využít je k útoku.

Packit 1470ea
Packit 1470ea
    

Standardním způsobem předcházení šíření neplatných dat je kontrolovat všechny vstupy do a výstupy ze všech veřejně viditelných funkcí v knihovně nebo modulu. Existují dvě úrovně kontroly:

Packit 1470ea
    <terms>
Packit 1470ea
      <item>
Packit 1470ea
        <title>Aserce</title>
Packit 1470ea
        

Kontrolují programové chyby a při selhání program přeruší.

Packit 1470ea
      </item>
Packit 1470ea
      <item>
Packit 1470ea
        <title>Validace</title>
Packit 1470ea
        

Kontrolují neplatný vstup a při selhání vhodně vracejí chybu.

Packit 1470ea
      </item>
Packit 1470ea
    </terms>
Packit 1470ea
Packit 1470ea
    

Validace je náročná záležitost, která se řeší pomocí <link xref="gerror">GErrors</link>. Zbývající část tohoto oddílu rozebírá úvodní a koncové podmínky asercí, které jsou určené čistě pro odhalování chyb programátora. Programátorskou chybou je, když je funkce zavolána způsobem, který je v dokumentaci uvedený jako zakázaný. Například když je předána hodnota NULL v parametru, pro který je uvedeno, že vyžaduje hodnotu, která není NULL, nebo když je předána záporná hodnota v parametru, který vyžaduje kladnou hodnotu. Programátorské chyby mohou nastat i na výstupu, například návratová hodnota NULL, když není uvedená v dokumentaci, nebo když není nastaven výstup GError při selhání.

Packit 1470ea
Packit 1470ea
    

Přidání úvodních a koncových podmínek asercí do kódu je hlavně o zajištění správného chování a jeho podrobného uvedení v dokumentaci, než o vlastním přidání asercí. Všechny aserce by měly být zdokumentované, nejlépe pomocí příslušné <link xref="introspection">anotace k introspekci</link>, jako je (nullable).

Packit 1470ea
Packit 1470ea
    

Úvodní a závěrečné podmínky asercí jsou implementovány pomocí <link href="https://developer.gnome.org/glib/stable/glib-Warnings-and-Assertions.html#g-return-if-fail">g_return_if_fail()</link> a <link href="https://developer.gnome.org/glib/stable/glib-Warnings-and-Assertions.html#g-return-val-if-fail">g_return_val_if_fail()</link>.

Packit 1470ea
Packit 1470ea
    

Úvodní podmínky by měly kontrolovat jednotlivé parametry hned na začátku funkce, dříve než je proveden jakýkoliv další kód (i třeba načtení privátní datové struktury z GObject, protože by například mohl mít ukazatel na GObject hodnotu NULL). Koncové podmínky by měly kontrolovat návratovou hodnotu a případné výstupní parametry na konci funkce, což vyžaduje jediný výraz return a použití příkazu goto pro sloučení ostatních průchodových cest do něj. Příklad viz <link xref="memory-management#single-path-cleanup"/>.

Packit 1470ea
  </section>
Packit 1470ea
</page>