Home > Articles > Programming > C/C++

Adding an Easy File Save and File Load Mechanism to Your C++ Program

Why waste your time figuring out an algorithm for storing things in a file? And why spend time debugging the code? Let the Boost library do it for you. Saving your data to your own custom-made file formats is easy with the help of the Boost serialization templates. Jeff Cogswell shows you how to save the data and read it back in with ease.
Like this article? We recommend

When you create a software package, you want to focus on making the software do what it is intended to do. The last thing you want to worry about is spending hours writing something that could apply to millions of other software programs out there. That's what reuse is for, and hopefully somebody already wrote that piece of code for you.

A good example of this type of problem is giving your program the capability to save documents. For example, you might be writing the greatest astronomy program ever—in this program your users can easily put in the current time and coordinates, and the program maps the current sky. But suppose that you give the users the ability to highlight certain stars so they easily stand out in the map. And finally, you want the users to be able to save their configuration for later use.

Your program focuses on astronomy. You are not writing a general-purpose library for saving documents, so you shouldn't have to spend too much time on the saving features. You want to focus on the astronomy features of the program. If you're using C++, you can get help for such reusability from the Boost library. For saving files, the Boost library includes a serialization class, which is exactly what you need.

If you built your program well, you probably have a class containing the user information, or a document. For example, you might have a class that lists the names of the user's favorite stars favorite location. (I haven't written an astronomy program, so forgive me for the simplicity here!) And that's the information you want your users to be able to save to disk. After all, almost any program does file saving. Microsoft Word saves text and formatting data. Excel saves spreadsheet data. A mapping program such as Streets and Trips or Street Atlas saves favorite locations, GPS routes, trips, and so on.

With the help of the Boost serialization library, saving is easy. All you have to do is set up your classes correctly, and the library takes care of the rest—allowing you to focus on your real work.

The idea is simple: You create an object containing the user's data. When ready to save the information, the user chooses File, Save As and selects a filename from the file dialog box that opens. With the help of Boost, your program then saves the data to the chosen file. Later, when the user restarts the program, chooses File, Open, and selects the saved file, your program again uses Boost—but this time to reload the data, thereby re-creating the object. Voila, the user data is restored! Or, from the eyes of the user, the document has been opened.

Because I'm not an expert on astronomy programs, I've written a sample that instead demonstrates the saving and loading of some graphic classes. The first class, Vertex, represents a point in two dimensions. The second class, Polygon, contains a container of Vertex instances. The third class, Drawing, contains a container of Polygon instances.

Trying to save all this to a document might be nightmarish and it's not something you want to focus your time on. You want to have the best graphics program around because that's your field of expertise. Why waste your time figuring out an algorithm for storing things in a file? And why spend time debugging such code? Let the Boost library do it for you.

Serializing a Class

First, consider the Vertex class. That's the easiest one to serialize because it doesn't contain containers of other objects. It just contains two values, x and y, both of type double. I also gave the class some accessor functions for the x and y values, as well as a dump function, which prints out the values of x and y to the console. Finally, I also included two constructors, a default, and one that takes an initial x and y value. (To keep it simple, this program doesn't actually do any real drawing. Sorry!)

That's all pretty easy. The exciting part is adding the necessary lines to make the class serialized. Following is the class (the basic stuff is shown in regular text; the serialization lines are shown in bold):

class Vertex {
private:
  friend class boost::serialization::access;
  template<class Archive>
  void serialize(Archive & ar, const unsigned int version)
  {
    ar & x;
    ar & y;
  }
  double x;
  double y;
public:
  Vertex() {} // Serialization requires a default constructor
  Vertex(double newX, double newY) : x(newX), y(newY) {}
  double getX() const { return x; }
  double getY() const { return y; }
  void dump() {
    cout << x << " " << y << endl;
  }  
}; 

Note that in the final program I won't actually be using the default constructor, Vertex(), but the serialization library does call it, so I need to include it.

The first of the serialization lines allows the serialization library access to the private members, particularly the serialize function, which comes next. The creator of the serialization library, Robert Ramey, points out that you do not want any functions, including those in derived classes, calling your serialize method; you want it called only by the serialization library. To give your class the right protection, therefore, you want to make the serialize function private and then grant restricted access to the serialization library by making the boost::serialization::access class a friend of your class, as I did in this code.

Next is the serialize function, which is a template function. If you're not that familiar with template functions, I have good news for you: You don't need to understand the template portions of this function to make it work. Whew! Instead, make sure that you understand the meat of the serialize function—the part in-between braces:

ar & x;
ar & y; 

First, let me be clear: These two lines of code do not declare reference variables, even though that's what they look like they do. Instead, they invoke an & operator and do the work of writing your members to a file or reading them in. Yes, you read that correctly; this function kills two birds with one stone (or to be more politically correct, accomplishes two tasks with one set of code). When you're saving a Vertex object to a file, the serialization library calls this serialize function; the first line writes the x value to the file, and the second line writes the y value to the file. Later, when you're reading a Vertex object back in from a file, the first line reads in the x value from the file, and the second line reads in the y value from the file.

That's some serious fancy-schmancy operator overloading! The & character is, in fact, an operator defined down in the bowels of the serialization library, and the good news is that you don't need to know how it works. (I didn't bother looking at the serialization source code. You can if you want, but you don't have to in order to use it.)

Well that's pretty simple. Here's some sample code for you in case you want to try out just saving a Vertex object into a file:

Vertex v1(1.5, 2.5);
std::ofstream ofs("myfile.vtx");
boost::archive::text_oarchive oa(ofs);
oa << v1;
ofs.close();

That's it! The first line creates the Vertex object. The next four lines open a file, associate a special serialization class with the file, write to the file, and close the file. Now here's some code to read in a Vertex object from this file:

Vertex v2;
std::ifstream ifs("myfile.vtx", std::ios::binary);
boost::archive::text_iarchive ia(ifs);
ia >> v2;
ifs.close();
v2.dump();

This code creates an instance of Vertex and then again opens a file (but this time for reading), associates a serialization class with the file, reads the object in, and closes the file. Finally, the code dumps out the values of the Vertex. If you put the two preceding blocks of code in a main function and run it, you'll see the original two values, 1.5 and 2.5, print out.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020