Wczytywanie zawartości pliku, a kontrola błędów

Wprowadzenie

Najtrudniejszym elementem w dziedzinie wytwarzania oprogramowania jest zapewnienie właściwej obsługi błędów w powstającej aplikacji. Programista tworzący kod musi bowiem z pełną świadomością pisać każdą linijkę kodu, zadając sobie przy tym różne pytania związane z jego bezpieczeństwem. Oto kilka przykładowych pytań pojawiających się każdego dnia w pracy programisty:

• "Czy tworzony fragment kodu może zadziałać źle dla skrajnie niepoprawnych danych wejściowych?",
• "Jak powinien zachować się fragment kodu w przypadku niepoprawnych danych?",
• "Czy analizowany fragment kodu prawidłowo obsłuży wszystkie nieoczekiwane błędy?".

Z czasem pojawią się również inne pytania:

• "Jak pisać bezpieczny kod?",
• "Jak zabezpieczyć się przed występowaniem błędów w kodzie?",
• "Czy da się automatycznie testować poprawność działania kodu?".

Choć powyższe pytania pozostaną na chwilę obecną bez odpowiedzi, to mimo wszystko warto zacząć zwracać szczególną uwagę na wszelkie problemy związane z bezpieczeństwem i obsługą błędów. Pomimo, iż aspekty związane z wytwarzaniem bezpiecznego kodu są miejscami bardzo ciekawe, to teraz musimy wrócić do właściwej części rozdziału. W niniejszej lekcji skoncentrujemy się na zagadnieniach związanych z obsługiwaniem błędów, jakie mogą się pojawić podczas pracy z plikami.

Pliki, a narzędzia do kontroli błędów

Pracując z plikami w trybie do odczytu kontroluje się przede wszystkim dane, które się z nich odczytuje. W idealnym przypadku dane w plikach są zawsze poprawne, ponieważ pliki używane przez własne programy zazwyczaj są stworzone przez nas samych. Problem zaczyna się pojawiać wtedy, gdy użytkownik aplikacji będzie mógł samodzielnie przygotować plik z danymi, a te z kolei mogą okazać się niekoniecznie poprawne dla Twojego programu. Z pomocą przychodzą nam wówczas takie metody jak eof, good, bad, fail oraz clear, należące do znanej już Ci klasy ifstream. Ten sam zestaw metod dostępny jest również w innych strumieniach wejściowych, na przykład w std::cin, więc metody fail() i clear() powinny być Ci już znane. Informacje o błędzie w strumieniu zapisywane są w trzech flagach: eofbit, failbit, badbit.

Czym są flagi błędów?

Flagi są to w dużym uproszczeniu zmienne, które przechowują informacje o stanie obiektu. Jedna flaga opisuje jeden stan i może przyjmować tylko dwie wartości tj. zero lub jeden. Wartość 'jeden' można utożsamiać z wartością true, choć znacznie częściej mówi się, że flaga jest ustawiona. Analogicznie jest z wartością 'zero', którą utożsamia się z wartością false i wówczas mówi się, że dana flaga nie jest ustawiona. Flagi błędów można więc wyobrazić sobie jako zmienne, które przechowują informacje o błędach jakie wystąpiły podczas używania pliku. Flagi błędów już poznałeś, jednak nie zostały one do tej pory tak nazwane. Na Twoim poziomie wiedzy flagi mógłbyś wyobrazić sobie tak:
Znaczenie tych flag opisuje poniższa tabela:

flaga	opis
failbit	Operacja zakończyła się błędem. Przykładowo: nie udało otworzyć się pliku, napotkano błędne dane wejściowe (oczekiwano liczby, napotkano litery)
badbit	Wystąpił poważny błąd. Na przykład napotkano bad sector na dysku, albo urządzenie wejściowe przestało być dostępne. Różni się od zwykłego błędu tym, że po wystąpieniu poważnego błędu strumień nie musi być zdatny do użycia.
eofbit	Napotkano koniec pliku.

Metody good(), bad(), fail(), eof()

Więc co dokładnie zwracają te cztery metody?

• good() zwraca informację, czy żadna flaga błędu nie jest ustawiona,
• bad() zwraca informację, czy badbit jest ustawiony,
• fail() zwraca informację, czy failbit, lub badbit jest ustawiony,
• eof() zwraca informację, czy eofbit jest ustawiony.

Pamiętaj, że good() nie jest ani negacją, ani zamiennikiem fail(). Nigdy nie używaj good() do sprawdzania, czy nie wystąpił błąd odczytu. Jeśli napiszesz pętlę czytającą liczby z pliku i warunek pętli będzie oparty o metodę good(), lub eof(), to ta pętla nie zawsze będzie działać poprawnie. Osiągnięcie końca pliku w trakcie wczytywania liczby nie oznacza, że ta operacja zakończy się błędem!

Flagi, a ich reprezentacja w pamięci

Bardzo ważną cechą flag jest to, że można ich stan przechowywać na jednym bicie. Wspomnianą własność wykorzystuje się do zapisywania w jednej zmiennej kilku różnych informacji, dzięki czemu aplikacja zajmuje mniej miejsca w pamięci. Widząc pojęcie flag w kontekście programowania powinieneś wiedzieć, że chodzi o jedną zmienną, która przechowuje wiele flag, gdzie każda flaga oznacza jedną, konkretną informację. Przykładowo zmienna typu char zajmuje jeden bajt, a bajt składa się z 8 bitów, więc na jednym bajcie można przechować aż 8 flag. Do tego celu wykorzystuje się operacje bitowe, które w odpowiednim momencie zostaną omówione, jednak na chwilę obecną na tym się kończy teoria związana z flagami.

Stosowane techniki obsługi błędów

Poznałeś już narzędzia umożliwiające kontrolowanie poprawności wczytywanych danych. Warto również w tym rozdziale dowiedzieć się czegoś więcej, tj. jak wykorzystuje się poznane mechanizmy do kontroli błędów. Generalnie rzecz biorąc można wyróżnić trzy podejścia obsługi plików:

• Jeżeli podczas wczytywania pliku napotkamy jakikolwiek błąd to kończymy wczytywanie plików i informujemy użytkownika o niepowodzeniu (np. "błędny format danych pliku - wczytywanie danych zakończyło się niepowodzeniem"),
• Jeżeli wczytanie pliku zakończyło się niepowodzeniem, to informujemy użytkownika o miejscu wystąpienia błędu w pliku (np. "wystąpił błąd w wierszu 13, kolumna 15 - oczekiwano znaku '(', a napotkano znak '{'"),
• Trzecie podejście polega na ignorowaniu błędnych wierszy z danymi i odczytywaniu wszystkiego co się da w sposób poprawny (takie podejście się przydaje w przypadku, gdy plik uległ częściowemu nadpisaniu i próbujemy odzyskać maksymalną ilość utraconych danych).

Każde z powyższych podejść ma swoje zalety i wady. Najczęściej spotykanym rozwiązaniem jest podejście pierwsze tj. albo się uda wczytać wszystkie dane albo użytkownik jest informowany o wystąpieniu błędu i wówczas żadne dane nie są wyświetlane na ekranie. Takie rozwiązanie jest praktyczne i najmniej czasochłonne, więc do większości pisanych aplikacji warto stosować właśnie to podejście.

Przykład

Czas podsumować wiedzę zdobytą w niniejszym rozdziale w postaci trochę większego programu. Nie ma sensu rozważać programu do odczytywania danych z pliku, bez wcześniejszego zdefiniowania, jak plik ma wyglądać. Format danych, w jakimś stopniu, zawsze musi być zdefiniowany. Załóżmy plik tekstowy, w którym występują liczby całkowite, oraz inne znaki. Na przykład:
Celem jest wypisanie każdej napotkanej liczby i każdego napotkanego znaku.

Podsumowanie

Zagadnieniom związanym z wykrywaniem i obsługą błędów poświęcono wbrew pozorom dużo książek oraz publikacji, które stanowią całkiem spory obszar w dziedzinie informatyki. U podstaw tworzenia bezpiecznego kodu leży jednak przede wszystkim świadomość, doświadczenie i umiejętności analityczne programisty. Wiedz, że każdy programista doskonali swoje umiejętności latami poprzez okazjonalne czytanie książek i przede wszystkim poprzez pisanie setek tysięcy linii kodu, podczas realizacji wymyślonych przez siebie (bądź zleconych) projektów. Pamiętaj, że zdobyte przez Ciebie doświadczenie, jak również zaangażowanie w realizowane projekty będą kluczowymi elementami, wpływającymi pozytywnie na jakość kodu, a tym samym na jego odporność na błędy.

Zadanie domowe

1. Napisz program, który wczyta z pliku liczby całkowite i wypisze je na ekranie. Wszelkie nieprawidłowe znaki mają zostać pominięte. Program ma wypisać również sumę wszystkich wczytanych liczb. Przykładowa zawartość pliku z danymi:
Oczekiwane standardowe wyjście programu dla przykładowego zestawu danych:
2. [trudne zadanie] Napisz program, który dla każdego wiersza w pliku:

• wczyta liczby i wypisze ich sumę w przypadku, gdy wszystkie liczby uda się wczytać;
• wypisze komunikat o błędnych danych, jeżeli wystąpi błąd podczas wczytywania liczb (komunikat ma wyświetlać numer wiersza, w którym wystąpił błąd).

Przykładowe dane:
Oczekiwane standardowe wyjście programu dla przykładowego zestawu danych:
Wykorzystaj poniższą funkcję do wykrywania znaku przejścia do nowej linii:
Powyższej funkcji nie wolno modyfikować.