Include fstream c что это

Include fstream c что это

БлогNot. Лекции по C/C++: работа с файлами (fstream)

Лекции по C/C++: работа с файлами (fstream)

Механизм ввода-вывода, разработанный для обычного языка С, не соответствует общепринятому сегодня стилю объектно-ориентированного программирования, кроме того, он активно использует операции с указателями, считающиеся потенциально небезопасными в современных защищённых средах выполнения кода. Альтернативой при разработке прикладных приложений является механизм стандартных классов ввода-вывода, предоставляемый стандартом языка C++.

Открытие файлов

Наиболее часто применяются классы ifstream для чтения, ofstream для записи и fstream для модификации файлов.

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

Ниже приведены возможные значения флагов и их назначение.

Например, чтобы открыть файл с именем test.txt для чтения данных в бинарном виде, следует написать:

Оператор логического ИЛИ ( | ) позволяет составить режим с любым сочетанием флагов. Так, чтобы, открывая файл по записи, случайно не затереть существующий файл с тем же именем, надо использовать следующую форму:

Предполагается, что к проекту подключён соответствующий заголовочный файл:

Для проверки того удалось ли открыть файл, можно применять конструкцию

Операторы включения и извлечения

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

Можно также записывать текстовую строку по частям:

Оператор endl завершает ввод строки символом «возврат каретки»:

С помощью оператора включения несложно записывать в файл значения переменных или элементов массива:

В результате выполнения кода образуется три строки текстового файла Temp.txt :

Обратите внимание, что числовые значения записываются в файл в виде текстовых строк, а не двоичных значений.

Оператор извлечения ( >> )производит обратные действия. Казалось бы, чтобы извлечь символы из файла Temp.txt , записанного ранее, нужно написать код наподобие следующего:

Однако оператор извлечения остановится на первом попавшемся разделителе (символе пробела, табуляции или новой строки). Таким образом, при разборе предложения «Текстовый массив содержит переменные» только слово «Текстовый» запишется в массив buff , пробел игнорируется, а слово «массив» станет значением целой переменной vx и исполнение кода «пойдет вразнос» с неминуемым нарушением структуры данных. Далее, при обсуждении класса ifstream , будет показано, как правильно организовать чтение файла из предыдущего примера.

Класс ifstream: чтение файлов

Как следует из расшифровки названия, класс ifstream предназначен для ввода файлового потока. Далее перечислены основные методы класса. Большая часть из них унаследована от класса istream и перегружена с расширением родительской функциональности. К примеру, функция get , в зависимости от параметра вызова, способна считывать не только одиночный символ, но и символьный блок.

Теперь понятно, как нужно модифицировать предыдущий пример, чтобы использование оператора извлечения данных давало ожидаемый результат:

Метод getline прочитает первую строку файла до конца, а оператор >> присвоит значения переменным.

Следующий пример показывает добавление данных в текстовый файл с последующим чтением всего файла. Цикл while (1) используется вместо while(!file2.eof()) по причинам, которые обсуждались в предыдущей лекции.

Этот код под ОС Windows также зависит от наличия в последней строке файла символа перевода строки, надежнее было бы сделать так:

Явные вызовы методов open и close не обязательны. Действительно, вызов конструктора с аргументом позволяет сразу же, в момент создания поточного объекта file , открыть файл:

Вместо метода close можно использовать оператор delete , который автоматически вызовет деструктор объекта file и закроет файл. Код цикла while обеспечивает надлежащую проверку признака конца файла.

Класс ofstream: запись файлов

Класс ofstream предназначен для вывода данных из файлового потока. Далее перечислены основные методы данного класса.

Описанный ранее оператор включения удобен для организации записи в текстовый файл:

Бинарные файлы

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

Первый параметр методов write и read (адрес блока записи/чтения) должен иметь тип символьного указателя char * , поэтому необходимо произвести явное преобразование типа адреса структуры void * . Второй параметр указывает, что бинарные блоки файла имеют постоянный размер байтов независимо от фактической длины записи. Следующее приложение дает пример создания и отображения данных простейшей записной книжки. Затем записи файла последовательно считываются и отображаются на консоли.

P.S. При выполнении этого и других листингов в Visual Studio последних версий может дополнительно понадобиться подключение директивы _CRT_SECURE_NO_WARNINGS.

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

Класс fstream: произвольный доступ к файлу

Предположим что в нашей записной книжке накопилось 100 записей, а мы хотим считать 50-ю. Конечно, можно организовать цикл и прочитать все записи с первой по заданную. Очевидно, что более целенаправленное решение — установить указатель позиционирования файла pos прямо на запись 50 и считать ее:

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

Если не указать флаг ios::ate (или ios::app ), то при открытии бинарного файла Notebook.dat его предыдущее содержимое будет стерто!

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

Наконец, можно открыть файл одновременно для чтения/записи, используя методы, унаследованные поточным классом fstream от своих предшественников. Поскольку класс fstream произведен от istream и ostream (родителей ifstream и ofstream соответственно), все упомянутые ранее методы становятся доступными в приложении.

Input/output with files

C++ provides the following classes to perform output and input of characters to/from files:

• ofstream : Stream class to write on files
• ifstream : Stream class to read from files
• fstream : Stream class to both read and write from/to files.

This code creates a file called example.txt and inserts a sentence into it in the same way we are used to do with cout , but using the file stream myfile instead.

But let’s go step by step:

Open a file

The first operation generally performed on an object of one of these classes is to associate it to a real file. This procedure is known as to open a file. An open file is represented within a program by a stream (i.e., an object of one of these classes; in the previous example, this was myfile ) and any input or output operation performed on this stream object will be applied to the physical file associated to it.

In order to open a file with a stream object we use its member function open :

open (filename, mode);

Where filename is a string representing the name of the file to be opened, and mode is an optional parameter with a combination of the following flags:

All these flags can be combined using the bitwise operator OR ( | ). For example, if we want to open the file example.bin in binary mode to add data we could do it by the following call to member function open :

Each of the open member functions of classes ofstream , ifstream and fstream has a default mode that is used if the file is opened without a second argument:

For ifstream and ofstream classes, ios::in and ios::out are automatically and respectively assumed, even if a mode that does not include them is passed as second argument to the open member function (the flags are combined).

For fstream , the default value is only applied if the function is called without specifying any value for the mode parameter. If the function is called with any value in that parameter the default mode is overridden, not combined.

File streams opened in binary mode perform input and output operations independently of any format considerations. Non-binary files are known as text files, and some translations may occur due to formatting of some special characters (like newline and carriage return characters).

Since the first task that is performed on a file stream is generally to open a file, these three classes include a constructor that automatically calls the open member function and has the exact same parameters as this member. Therefore, we could also have declared the previous myfile object and conduct the same opening operation in our previous example by writing:

Combining object construction and stream opening in a single statement. Both forms to open a file are valid and equivalent.

To check if a file stream was successful opening a file, you can do it by calling to member is_open . This member function returns a bool value of true in the case that indeed the stream object is associated with an open file, or false otherwise:

Closing a file

When we are finished with our input and output operations on a file we shall close it so that the operating system is notified and its resources become available again. For that, we call the stream’s member function close . This member function takes flushes the associated buffers and closes the file:

Once this member function is called, the stream object can be re-used to open another file, and the file is available again to be opened by other processes.

In case that an object is destroyed while still associated with an open file, the destructor automatically calls the member function close .

Text files

Text file streams are those where the ios::binary flag is not included in their opening mode. These files are designed to store text and thus all values that are input or output from/to them can suffer some formatting transformations, which do not necessarily correspond to their literal binary value.

Writing operations on text files are performed in the same way we operated with cout :

Reading from a file can also be performed in the same way that we did with cin :

Checking state flags

The following member functions exist to check for specific states of a stream (all of them return a bool value):

bad() Returns true if a reading or writing operation fails. For example, in the case that we try to write to a file that is not open for writing or if the device where we try to write has no space left. fail() Returns true in the same cases as bad() , but also in the case that a format error happens, like when an alphabetical character is extracted when we are trying to read an integer number. eof() Returns true if a file open for reading has reached the end. good() It is the most generic state flag: it returns false in the same cases in which calling any of the previous functions would return true . Note that good and bad are not exact opposites ( good checks more state flags at once).
The member function clear() can be used to reset the state flags.

get and put stream positioning

All i/o streams objects keep internally -at least- one internal position:

ifstream , like istream , keeps an internal get position with the location of the element to be read in the next input operation.

ofstream , like ostream , keeps an internal put position with the location where the next element has to be written.

Finally, fstream , keeps both, the get and the put position, like iostream .

These internal stream positions point to the locations within the stream where the next reading or writing operation is performed. These positions can be observed and modified using the following member functions:

tellg() and tellp()

These two member functions with no parameters return a value of the member type streampos , which is a type representing the current get position (in the case of tellg ) or the put position (in the case of tellp ).

seekg() and seekp()

These functions allow to change the location of the get and put positions. Both functions are overloaded with two different prototypes. The first form is:

seekg ( position );
seekp ( position );

Using this prototype, the stream pointer is changed to the absolute position position (counting from the beginning of the file). The type for this parameter is streampos , which is the same type as returned by functions tellg and tellp .

The other form for these functions is:

seekg ( offset, direction );
seekp ( offset, direction );

Using this prototype, the get or put position is set to an offset value relative to some specific point determined by the parameter direction . offset is of type streamoff . And direction is of type seekdir , which is an enumerated type that determines the point from where offset is counted from, and that can take any of the following values:

The following example uses the member functions we have just seen to obtain the size of a file:

Notice the type we have used for variables begin and end :

streampos is a specific type used for buffer and file positioning and is the type returned by file.tellg() . Values of this type can safely be subtracted from other values of the same type, and can also be converted to an integer type large enough to contain the size of the file.

These stream positioning functions use two particular types: streampos and streamoff . These types are also defined as member types of the stream class:

Each of the member types above is an alias of its non-member equivalent (they are the exact same type). It does not matter which one is used. The member types are more generic, because they are the same on all stream objects (even on streams using exotic types of characters), but the non-member types are widely used in existing code for historical reasons.

Binary files

For binary files, reading and writing data with the extraction and insertion operators ( << and >> ) and functions like getline is not efficient, since we do not need to format any data and data is likely not formatted in lines.

File streams include two member functions specifically designed to read and write binary data sequentially: write and read . The first one ( write ) is a member function of ostream (inherited by ofstream ). And read is a member function of istream (inherited by ifstream ). Objects of class fstream have both. Their prototypes are:

write ( memory_block, size );
read ( memory_block, size );

Where memory_block is of type char* (pointer to char ), and represents the address of an array of bytes where the read data elements are stored or from where the data elements to be written are taken. The size parameter is an integer value that specifies the number of characters to be read or written from/to the memory block.

In this example, the entire file is read and stored in a memory block. Let’s examine how this is done:

First, the file is open with the ios::ate flag, which means that the get pointer will be positioned at the end of the file. This way, when we call to member tellg() , we will directly obtain the size of the file.

Once we have obtained the size of the file, we request the allocation of a memory block large enough to hold the entire file:

Right after that, we proceed to set the get position at the beginning of the file (remember that we opened the file with this pointer at the end), then we read the entire file, and finally close it:

Buffers and Synchronization

When we operate with file streams, these are associated to an internal buffer object of type streambuf . This buffer object may represent a memory block that acts as an intermediary between the stream and the physical file. For example, with an ofstream , each time the member function put (which writes a single character) is called, the character may be inserted in this intermediate buffer instead of being written directly to the physical file with which the stream is associated.

The operating system may also define other layers of buffering for reading and writing to files.

When the buffer is flushed, all the data contained in it is written to the physical medium (if it is an output stream). This process is called synchronization and takes place under any of the following circumstances:

How to Use C++ fstream

It is possible for inputting and outputting to take place in one session. This is made possible by the class template, basic_fstream. Now, fstream is a synonym for basic_fstream. fstream, which is still basic_fstream, uses basic_ifstream and ofstream to operate.

In order to do input alone, do output alone, or both in one session, it suffices to start the C++ program with the following includes and namespace invocations:

This tutorial has four main sections: opening and closing of a file stream, output file stream, appending, input file stream, and editing a file. Editing a file means inputting and outputting a stream.

Article Content

Opening and Closing a File Stream

Before a stream can be opened, a stream object has to be created. Opening a stream means establishing a channel between the C++ program and the file in disk. This is accomplished through which the sequence of characters will move to the file; or through which sequence of characters will leave the file and come to the program; or through which characters will move to-and-fro.

A stream is opened only for writing (output), reading (input), or both reading and writing. It can also be opened for other reasons.

Before opening a stream, the stream object has to be constructed. The simplest way to express it is as follows in the C++ main() function:

Now, with the strm object, the fstream member functions, open() and close() can be used, preceding each with the dot operator. The following statement can be used to open an fstream for reading:

The open() member function returns void.

With the stream object, the statement would be:

Since the open() member function returns void, to know if the file in the disk was successfully opened, use the member function:

It returns zero for false if the file did not open and 1 for true if the file opened. Now our program looks like this so far:

#include <fstream>
#include <iostream>
using namespace std ;

int main ( ) {
fstream strm ;
strm. open ( "./myfile" , ios_base :: in ) ;

To open a file for writing, use this flag:

ios_base::in means open for reading and ios_base::out means open for writing. To open a file for reading and writing, use:

Note: the presence of “ios_base::in | ios_base::out”, which uses logical OR to combine both flags as a single argument to the function.

Closing a stream means closing the channel through which data can be sent to and fro between the program and the file. No more datum can be sent in either direction using that channel. Closing the stream is not closing the stream object. The same stream can still be used to open a new channel, which should be closed after use in transmission of data. Make it a habit of closing any file stream, after it has been opened. When a stream is closed, any data in memory that was supposed to have been in the file is sent to the file before actually closing. The member function prototype to close fstream is:

It returns void, unfortunately. So, to know whether the closing was successful, use the member function:

If the closing were successful, this would return zero, meaning the stream is no longer open. If the closing were unsuccessful, it would return 1 and meaning the stream could not be closed.

Output File Stream Operation

Now we will demonstrate opening a file and giving it new data content. To open an output stream with fsream, just use ios_base::out alone in the open() member function. The following program opens a file, and it sends the content of a string to it:

#include <fstream>
#include <iostream>
using namespace std ;

fstream strm ;
strm. open ( "doc1.txt" , ios_base :: out ) ;
if ( ! strm. is_open ( ) ) {
cout << "File could not be opened!" << endl ;
return 1 ;
}

char str [ ] = "A: This is the first line. \n "
"B: This is the second line. \n "
"C: This is the third line. \n " ;

strm << str ;
strm. close ( ) ;
if ( strm. is_open ( ) ) {
cout << "Stream could not close!" << endl ;
return 1 ;
}
cout << "Success, check file" << endl ;
return 0 ;
}

The name of the file is doc1.txt can include a full path or a relative path. The new content is identified by str in the program. At the end of the program, the string content would have been inserted into the stream and thus, the file with the statement:

Cout is a standard output object, and it is typically used for the console. It uses the extraction operator, #include <fstream>
#include <iostream>
#include <cstring>
using namespace std ;