Click here to Skip to main content
11,565,743 members (42,023 online)
Click here to Skip to main content

CStdioFile-derived class for multibyte and Unicode reading and writing

, 19 Jul 2007 CPOL 348.5K 10.1K 104
Rate this:
Please Sign up or sign in to vote.
A class, derived from CStdioFile, which transparently reads and writes both Unicode and multibyte files. Version 1.5.

Demo app screenshot

Introduction

This is a class derived from CStdioFile which transparently handles the reading and writing of Unicode text files as well as ordinary multibyte text files.

The code compiles as both multibyte and Unicode. In Unicode, multibyte files will be read and their content converted to Unicode using the current code page. In multibyte compilations, Unicode files will be read and converted to multibyte text.

The identification of a Unicode text file depends entirely on the presence of the Unicode byte order mark (0xFEFF). Its absence is not an absolute guarantee that a file is not Unicode, but it's the only method I use here. Feel free to suggest improvements.

By default, the class writes multibyte files, but can optionally write Unicode.

Background

The ability to transparently handle both multibyte and Unicode seems to be such a fundamental requirement, that I was sure that there would already be something similar on offer, and yet nothing turned up. Did I miss something?

I needed it for a translation tool I wrote, and knocked together an implementation that was good enough for my needs. This is little more than a cleaned up version of that, so expect bugs and all manner of deficiencies. I've tested the demo app though with the basic combinations -- Unicode files in a multibyte compilation, Unicode-Unicode, Multibyte-Unicode, and Multibyte-Multibyte, and they all seem to work.

Using the code

The use of the class is pretty simple. It overrides three functions of CStdioFile: Open(), ReadString() and WriteString(). To write a Unicode file, add the flag CStdioFileEx::modeWriteUnicode to the flags when calling the Open() function.

In other respects, usage is identical to CStdioFile.

To find out if a file you have opened is Unicode, you can call IsFileUnicodeText().

To get the number of characters in the file, you can call GetCharCount(). This is unreliable for multibyte/UTF-8, however.

An example of writing in Unicode:

// Test writing
CStdioFileEx fileWriteUnicode;

if (fileWriteUnicode.Open(_T("c:\\testwrite_unicode.txt"), 
    CFile::modeCreate | CFile::modeWrite | CStdioFileEx::modeWriteUnicode))
{
    fileWriteUnicode.WriteString(_T("Unicode test file\n"));
    fileWriteUnicode.WriteString(_T("Writing data\n"));
    fileWriteUnicode.Close();
}

You can now also specify the code page for multibyte file reading or writing. Simply call SetCodePage() before a read to tell CStdioFileEx which code page the file is coded in, or before a write, to tell it which code page you want it written in. Specifying CP_UTF8 as the code page allows you to read or write UTF-8 files.

The demo app is a dialog which opens a file, tells you whether it's Unicode or not and how many characters it contains, and shows the first fifteen lines from it. In the last couple of iterations I've added the option to convert a Unicode file to multibyte, and a multibyte file to Unicode, and a combo to specify the code page when reading.

As of v1.6, there is no limitation on the length of the line that can be read in any mode (Multibyte/Unicode, Unicode/Multibyte, etc.).

I'd love to hear of people's experiences with it, as well as reports of bugs, problems, improvements, etc.

Oh, and if I've accidentally included something offensive in the demo dialog, let me know. My Arabic and Chinese are not all that good.

History

  • v1.0 - Posted 14 May 2003
  • v1.1 - 23 August 2003. Incorporated fixes from Dennis Jeryd
  • v1.2 - 06 January 2005. Fixed garbage at end of file bug (Howard J Oh)
  • v1.3 - 19 February 2005. Howard J Oh's fix mysteriously failed to make it into the last release. Improved the test program. Fixed miscellaneous bugs
    Very important: In this release, ANSI files written in ANSI are no longer written using WriteString. This means \n will no longer be "interpreted" as \r\n. What you write is what you get
  • v1.4 - 26 February 2005. Fixed submission screw-up
  • v1.5 - 18 November 2005. Code page can be specified for reading and writing (inc. UTF-8). Multibyte buffers properly calculated. Fix from Andy Goodwin
  • v1.6 - 19 July 2007. Major rewrite: Maximum line length restriction removed; Use of strlen/lstrlen eliminated. Conversion functions always used to calculate required buffers; \r or \n characters no longer lost; BOM writing now optional; UTF-8 reading and writing works properly; systematic tests are now included with the demo project

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

David Pritchard
Software Developer (Senior)
Spain Spain
I'm originally from Leek, Staffordshire in the UK, but I now work as a C++/MFC developer in Madrid, Spain.

I followed an erratic study/career path from German to a PhD in something resembling political science and linguistics, eventually ending up in IT.

I'm still finding bustling streets, warm nights, beer and vitamin D a pretty heady combination.

You may also be interested in...

Comments and Discussions

 
QuestionHas the project changed since 2007? Pin
Byteman13-May-15 15:48
memberByteman13-May-15 15:48 
QuestionLicense Pin
snco322-Oct-13 14:10
membersnco322-Oct-13 14:10 
Questionggets.cpp bug Pin
David Pritchard9-Dec-12 1:44
memberDavid Pritchard9-Dec-12 1:44 
AnswerRe: ggets.cpp bug Pin
David Pritchard14-Jan-13 0:44
memberDavid Pritchard14-Jan-13 0:44 
QuestionCool stuff! Pin
napoapo20-Nov-12 6:19
membernapoapo20-Nov-12 6:19 
QuestionIs it possible to read a file 1 character at a time? Pin
BTownTKD17-Jul-12 8:32
memberBTownTKD17-Jul-12 8:32 
GeneralMy vote of 5 Pin
onnlv7-Jun-12 17:50
memberonnlv7-Jun-12 17:50 
AnswerYou are a great man, but not great enough. Pin
vLinus4-Jun-12 5:46
membervLinus4-Jun-12 5:46 
GeneralRe: You are a great man, but not great enough. Pin
napoapo20-Nov-12 5:56
membernapoapo20-Nov-12 5:56 
BugWarning: do not use parameterised constructor!! Pin
David Pritchard23-Mar-12 5:05
memberDavid Pritchard23-Mar-12 5:05 
GeneralMy vote of 5 Pin
professore20-Feb-12 22:46
memberprofessore20-Feb-12 22:46 
GeneralRe: My vote of 5 Pin
David Pritchard23-Mar-12 5:02
memberDavid Pritchard23-Mar-12 5:02 
QuestionExtrange behavior writting through network Pin
Member 15651628-Nov-11 23:18
memberMember 15651628-Nov-11 23:18 
AnswerRe: Extrange behavior writting through network Pin
David Pritchard3-Jan-12 4:12
memberDavid Pritchard3-Jan-12 4:12 
GeneralMy vote of 3 Pin
buyong17-Oct-11 19:22
memberbuyong17-Oct-11 19:22 
GeneralRe: My vote of 3 Pin
David Pritchard3-Jan-12 4:12
memberDavid Pritchard3-Jan-12 4:12 
QuestionNeed help to read and write empty characters Pin
Coder Block1-Sep-11 18:43
memberCoder Block1-Sep-11 18:43 
AnswerRe: Need help to read and write empty characters Pin
David Pritchard3-Jan-12 4:20
memberDavid Pritchard3-Jan-12 4:20 
GeneralRe: Need help to read and write empty characters Pin
Coder Block11-Jan-12 23:47
memberCoder Block11-Jan-12 23:47 
GeneralRe: Need help to read and write empty characters Pin
David Pritchard25-Jan-12 22:44
memberDavid Pritchard25-Jan-12 22:44 
GeneralRe: Need help to read and write empty characters Pin
Coder Block30-Jan-12 23:29
memberCoder Block30-Jan-12 23:29 
GeneralRe: Need help to read and write empty characters Pin
David Pritchard31-Jan-12 23:25
memberDavid Pritchard31-Jan-12 23:25 
QuestionJust to let people know Pin
David Pritchard25-Jul-11 4:51
memberDavid Pritchard25-Jul-11 4:51 
GeneralSpeed Pin
.dan.g.7-May-11 3:37
member.dan.g.7-May-11 3:37 
GeneralRe: Speed Pin
David Pritchard7-May-11 9:17
memberDavid Pritchard7-May-11 9:17 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.150624.2 | Last Updated 19 Jul 2007
Article Copyright 2003 by David Pritchard
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid