Click here to Skip to main content
Licence 
First Posted 12 Oct 2000
Views 93,940
Bookmarked 18 times

CList Iterator

By | 12 Oct 2000 | Article
A simple iteration class for MFC's CList linked list
  • Download source files - 1 Kb
  • Introduction

    MFC's CList provides a template linked list implementation and works perfectly adequately. However, iterating through the list can be a little combersome. Code like that below is common place for processing list elements, but the POSITION variable is meaningless and confusing as it always points to the next node rather than the current one.

    POSITION        pos;
    CList<int, int> list;
    
    // add nodes to the list
    
    pos = list.GetHeadPosition();
    while (pos)
    {
        int nElement;
    
        nElement = list.GetNext(pos);
        // do something with nElement
    }
    

    TLListIter class

    The iterator class I present here simplifies the use slightly, making the code easier to read and maintain. It originates from a larger project I wrote where I have a list of objects of type A, each with their own list of objects of type B, and I needed to iterate all objects of type B in the system. This class simplified the task immensly.

    So using this class, the above code becomes

    CList<int, int>      list;		// linked list
    TLListIter<int, int> iter(list);	// linked list iterator
    // add nodes to the list
    
    iter.begin();
    while (iter)
    {
        int nElement;
    
        nElement = iter++;
        // do something with nElement
    }
    

    Public Members

    Construction/Destruction

    TLListIter(TLList<TYPE, ARG_TYPE> &__list);
    Constructor to initialise the iterator with the the linked list to be iterated.

    TLListIter(TLListIter<TYPE, ARG_TYPE> &__iter);
    Copy constructor to create a new iterator for the same linked list with the same node position.

    virtual ~TLListIter();
    Virtual class destructor.

    Operators

    operator bool ();
    Boolean operator will return true if there is a current node, or false if not.

    operator ARG_TYPE ();
    Linked List argument operator will returns the element at the current node.

    Navigation

    TLListIter<TYPE, ARG_TYPE> operator++(int);
    Post increment operator returns the current node and moves the internal position to the next node.

    TLListIter<TYPE, ARG_TYPE> operator--(int);
    Post decrement operator returns the current node and moves the internal position to the previous node.

    // these functions will return false if there are no elements in the list

    bool begin(void);
    Moves to the first node in the list. This function returns false if the linked list is empty.

    bool end(void);
    Moves to the last node in the list. This function returns false if the linked list is empty.

    MFC Compatibilty

    POSITION GetPosition(void) const;

    Returns the internal POSITION variable.

    Limitations

    • As the class stands, it cannot be used to process a list of bool. This is because of the operator bool() used to determine the end of the list.
    • For some reason unknown to me (please let me know any solutions) a compiler error is generated if the class is used while (nNumber == 7 && iter). Instead, this must be coded while (nNumber == 7 && iter == true) and then all is fine. Wierd.

    License

    This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

    A list of licenses authors might use can be found here

    About the Author

    Craig Henderson

    Other
    Centrix Software
    United Kingdom United Kingdom

    Member

    Follow on Twitter Follow on Twitter
    Craig graduated with a B.SC. Honours in Computing for Real Time Systems from the University of the West of England, Bristol in 1995 after completing an HND in Computing in 1993.

    Sign Up to vote   Poor Excellent
    Add a reason or comment to your vote: x
    Votes of 3 or less require a comment

    Comments and Discussions

     
    You must Sign In to use this message board. (secure sign-in)
     
    Search this forum  
     FAQ
        Noise  Layout  Per page   
      Refresh
    GeneralI'm translating the article Pinmemberjulianico4:14 20 Dec '05  
    GeneralMy diff List PinsussAnonymous22:25 30 Dec '03  
    GeneralMy diff List PinsussAnonymous22:23 30 Dec '03  
    GeneralIterator PinmemberAndre Pham8:28 29 Dec '03  
    GeneralPOSITION PinmemberRAyRAy15:34 26 May '02  
    Generalcode source seems not ok PinmemberLuc Vandal11:03 20 Nov '00  
    GeneralRe: code source seems not ok PinmemberCraig Henderson4:19 1 Dec '00  

    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.

    Permalink | Advertise | Privacy | Mobile
    Web02 | 2.5.120528.1 | Last Updated 13 Oct 2000
    Article Copyright 2000 by Craig Henderson
    Everything else Copyright © CodeProject, 1999-2012
    Terms of Use
    Layout: fixed | fluid