Drawing Barcodes in Windows Part 3 - I2of5

• Download source - 40 Kb

Introduction

A recent project at work required that I write out barcode characters into a font file for an old photo-typesetter. This experience inspired me to start a side project writing some code that renders a barcode on the Windows screen, given the proper input. This series of articles is the result of that project.

I2of5 basics

This third article is about drawing I2of5 barcodes on the Windows screen. Before I start discussing the code, we'll need to know some basic facts about the I2of5 barcode symbology. I2of5 is used today mainly in the distribution industry. I2of5 is a numeric-only symbology, with each I2of5 character encoding two digits, one in the bars and one in the spaces. This means that an I2of5 message must have an even number of digits. In each pair of digits, there are five bars, two of which are wide and three of which are narrow. There are also five spaces, two of which are wide and three of which are narrow. The encoding patterns for the 10 digits are listed below.

Character	Pattern
0	nnwwn
1	wnnnw
2	nwnnw
3	wwnnn
4	nnwnw
5	wnwnn
6	nwwnn
7	nnnww
8	wnnwn
9	nwnwn

An I2of5 message begins/ends with an a start/stop character. The start code consists of two narrow bars and two narrow spaces; the stop code consists of a wide bar, narrow space, and a narrow bar. A sample I2of5 message “012345” is shown below, complete with start and stop codes.

The Barcode Bitmap Workspace

There are three different projects in the Barcode Bitmap workspace. The first and most important project is the bblib project. This project is a static library where code to draw all of the different types of barcodes exists. This also is the main piece of code discussed in this series of articles. Another project Barcode Bitmap workspace is the bbdll project. This project is simply a regular DLL wrapper around the bblib static library. The final project in the Barcode Bitmap workspace is the DLL client project. This project is a simple dialog-based application that calls the bbdll DLL to draw barcodes in the dialog, or put barcodes on the clipboard as Windows bitmaps.

The base class CBarcode

The base class for all the barcode types discussed in this series of articles is the CBarcode class. The class declaration is listed below.

class CBarcode
{
    public:
        CBarcode();
        void LoadData(CString csMessage, double dNarrowBar, double dFinalHeight, 
                      HDC pDC, int nStartingXPixel, int nStartingYPixel, 
                      double dRatio = 1.0);
        virtual void DrawBitmap() = 0;
        virtual void BitmapToClipboard() = 0;
        virtual ~CBarcode();
        long GetBarcodePixelWidth();
        long GetBarcodePixelHeight();
    protected:
        CString m_csMessage;
        HDC m_hDC;
        long m_nFinalBarcodePixelWidth;
        long m_nNarrowBarPixelWidth;
        long m_nPixelHeight;
        long m_nStartingXPixel;
        long m_nStartingYPixel;
        long m_nSymbology;
        long m_nWideBarPixelWidth;
        virtual void DrawPattern(CString csPattern) = 0;
};

There are a few things to note about the CBarcode class. First note that it has data members that contain all of the useful data needed to draw a barcode message. This data includes the narrow element pixel width, the wide element pixel width, the message, and the symbology. Second the class has data members that contain information about how to output the barcode message. This data includes a device context handle, and a starting X and Y pixel. Third the class has some public member functions to intialize the class by loading data, and obtain information about the barcode message, namely its pixel height and width. Fourth the class has several abstract member functions that make this class an abstract base class. Any classes derived from CBarcode will be expected to implement these functions.

The CI2of5 class

The CI2of5 class is the class to implement to draw an I2of5 barcode. The class declaration is listed below.

class CI2of5 : public CBarcode  
{
public:
    void BitmapToClipboard();
    void DrawBitmap();
    CI2of5();
    virtual ~CI2of5();
private:
    CString RetrievePattern(int nTwoDigitNumber);
    void DrawPattern(CString csCharPattern);

};

The class has two public functions BitmapToClipboard() and DrawBitmap(), plus it inherits the LoadData() function from the CBarcode class. The steps to use the class are simple, declare an instance of the class, call LoadData() to intialize class data, and then call either BitmapToClipboard() if you want to put a bitmap of the barcode on the clipboard, or call DrawBitmap() to draw the barcode message.

Drawing a Barcode to a Device Context

The following code snipet is an example using DrawBitmap().

CString            csMessage;
double            dNarrowBar,dHeight, dRatio;
HDC            pDC;
long            nStartingXPixel, nStartingYPixel;
CI2of5            oBarcode;

// assign variable values here

// call LoadData and draw the barcode
oBarcode.LoadData(csMessage,dNarrowBar,dHeight,pDC,
                  nStartingXPixel,nStartingYPixel,dRatio);
oBarcode.DrawBitmap();

Drawing a Barcode to the Clipboard

The following code snipet is an example using BitmapToClipboard().

HDC            hDC = NULL;
double            dNarrowbar,dHeight,dRatio;
CI2of5            oBarcode;

// assign variable values here

// call LoadData and BitmapToClipboard()
oBarcode.LoadData(csMessage,dNarrowBar,dHeight,hDC,0,0,dRatio);
oBarcode.BitmapToClipboard();

Note that when using the BitmapToClipboard() function, you can pass a null device context handle and zeroes for the starting X and Y pixel in the LoadData() call. Obviously the starting X and Y pixels are meaningless on the clipboard, but what about the null device context handle? The answer to that question can be found by looking at this code snipet from the BitmapToClipboard() function.

CDC    memDC;
memDC.CreateCompatibleDC(NULL);

So the BitmapToClipboard() function creates its own memory device context by using the memDC.CreateCompatibleDC(NULL) function call. A quick look at the MSDN documentation shows that if you pass a NULL value to CreateCompatibleDC, the device context created is compatible with the screen.

CBarcode::LoadData() details

The parameters for CBarcode::LoadData() deserve some further explanation and this seems like the place to do it. The first parameter, csMessage is simply the message you wish to be drawn as a I2of5 barcode. The next parameter dNarrowBar is the width of the narrow element in inches. The parameter dHeight is the height of the barcode in inches. The parameter pDC is a handle to the device context that the barcode will be drawn in. The next two parameters, nStartingXPixel and nStartingYPixel define the coordinates to start drawing the barcode. The final parameter, dRatio is the ratio of wide/narrow element widths. If you remember the declaration of the CBarcode class above, you'll remember that it stores all width and height information in pixels, and that it stores the narrow element width and the wide element width instead of the narrow element width and the wide/narrow element width ratio. Clearly CBarcode::LoadData() is doing some behind the scenes conversion work.

The first step to that conversion work is to get the X axis and Y axis dpi, which is done by the following code, taken from CBarcode::LoadData().

CDC    tempDC;
tempDC.Attach(m_hDC);
nXAxisDpi = tempDC.GetDeviceCaps(LOGPIXELSX);
nYAxisDpi = tempDC.GetDeviceCaps(LOGPIXELSY);
tempDC.Detach();

Once you have the X and Y axis dpi, you can calculate the pixel height, narrow element pixel width, and wide element pixel width as shown in the following code snipet.

// load the final attributes that depend on the device context
m_nPixelHeight = (int)((nYAxisDpi*dFinalHeight)+0.5);
m_nNarrowBarPixelWidth = (int)((nXAxisDpi*dNarrowBar)+0.5);
m_nWideBarPixelWidth = (int)(dRatio*m_nNarrowBarPixelWidth);

Note the rounding effect when calculating the narrow element pixel width and the wide element pixel width. The narrow element width has a lower limit of one pixel, so the barcode you can produce is limited by the physical limitations of the output device.

Next you can calculate the final barcode pixel width, this operation is symbology specific and the Code 39 code excerpt is listed below.

// add start code
m_nFinalBarcodePixelWidth = 4 * m_nNarrowBarPixelWidth;

// add message
m_nFinalBarcodePixelWidth += ((3*m_nNarrowBarPixelWidth)+(2*m_nWideBarPixelWidth))
                              *m_csMessage.GetLength();
        
// add stop code
m_nFinalBarcodePixelWidth += (2*m_nNarrowBarPixelWidth)+(m_nWideBarPixelWidth);

This code sums the width of the start code the message and the stop code to determine to final barcode width.

CI2of5::DrawBitmap() details

The DrawBitmap() function is where each message character is drawn.. A listing of the CI2of5::DrawBitmap() function is listed below.

void CI2of5::DrawBitmap()
{
    int        i,nNumber;

    // draw the start character
    DrawPattern("nnnn");

    // for each character in the message
    for (i=0;i<m_csMessage.GetLength();i+=2)
    {
        // retrieve the next two digit number
        nNumber = m_csMessage.GetAt(i) - '0';
        nNumber = nNumber * 10;
        nNumber += m_csMessage.GetAt(i+1) - '0';

        // draw the two digit number
        DrawPattern(RetrievePattern(nNumber));
    }

    // draw the stop character
    DrawPattern("wnn");

    return;
}

The CI2of5::DrawBitmap() function starts out by drawing the start code. The the code steps through every character in the message and draws the characters in two digit pairs. There are two private member functions that are used here. CI2of5::DrawPattern() draws the pattern passed to it, the pattern is a CString in the form of “nnnnwwwwnn” (the two digit pair '00') like the character data mentioned above. CI2of5::RetrievePattern() is basically a giant switch statement, retrieving the pattern for any legal two digit pair passed to it. (00 through 99) Note that each character pattern returned from CI2of5::RetrievePattern() draws two digit pairs, the bars are the left digit and the spaces are the right digit. Finally the code draws the stop character and the barcode message is complete.

CI2of5::DrawPattern() details

The CI2of5::DrawPattern() function draws a single I2of5 barcode character in the passed device context. The CI2of5::DrawPattern() function is listed below.

void CI2of5::DrawPattern(CString csCharPattern)
{
    int            i,nXPixel,nYPixel,nTempWidth;
    CDC            oDC;

    // attach to the device context
    oDC.Attach(m_hDC);

    // initialize X pixel value
    nXPixel = m_nStartingXPixel;
    
    for (i=0;i<csCharPattern.GetLength();i++)
    {
        // decide if narrow or wide bar
        if (csCharPattern.GetAt(i)=='n')
            nTempWidth = m_nNarrowBarPixelWidth;
        else
            nTempWidth = m_nWideBarPixelWidth;
        
        // X value for loop
        for (nXPixel=m_nStartingXPixel;
             nXPixel<m_nStartingXPixel+nTempWidth;
             nXPixel++)
        {
            // Y value for loop
            for (nYPixel=m_nStartingYPixel;
                 nYPixel<m_nStartingYPixel+m_nPixelHeight;
                 nYPixel++)
            {
                // if this is a bar
                if (i%2==0)
                    oDC.SetPixelV(nXPixel,nYPixel,COLORBLACK);
                else
                    oDC.SetPixelV(nXPixel,nYPixel,COLORWHITE);
            }
        }

        // advance the starting position
        m_nStartingXPixel+= nTempWidth;
    }

    // detach from the device context
    oDC.Detach();
    
    return;
}

The CI2of5::DrawPattern() function is basically three loops. The outermost loop loops thru every two digit pair in the pattern (nnnnwwwwnn). The middle loop loops through every X pixel in the current narrow or wide element width. The innermost loop loops through every Y pixel in the current X pixel. In the center of the three loops is a simple if statement that determines if we're drawing a bar or a space, and sets the current pixel to black or white for a bar or space. This function is repeated for the start character, all the message characters, and the stop character to draw the complete I2of5 barcode.

Summary

Thats it for drawing I2of5 barcodes. Part IV of the series deals with drawing Code 93 barcodes. I hope you find this class library useful.

Reference

The Bar Code Book - A Comprehensive Guide To Reading, Printing, Specifying, and Applying Bar Code and Other Machine-Readable Symbols 4th Edition

<p{>By Roger C. Palmer

Copyright 1989,1991, 1995, 2001 by Helmers Publishing, Inc.

ISBN 0-911261-13-3