Lab 10-2: 串列 (List) 的 Iterator 與 operator[]

還缺的功能包括

1. 順序將記錄在 StudentList 中的 Student 物件取出來 (這個功能我們將嘗試以兩種方式來達到: a. iterator b. operator[])

2. insert(): 在串列中某一個 Student 物件之後加入新的一個 Student 物件

    void main()
    {
        StudentList sList;
        sList.appendEntry(new Student("Mary Chen", "111111111", 
                                      "0933111111", 
                                      "Business"));
        sList.appendEntry(new Student("John Wang", "222222222", 
                                      "0928222222", 
                                      "Computer Science"));
        sList.appendEntry(new Student("Mel Lee", "333333333", 
                                      "0968333333", 
                                      "Mechanical Engineering"));
        sList.appendEntry(new Student("Bob Tsai", "444444444", 
                                      "0930444444", 
                                      "Electrical Engineering"));
        sList.appendEntry(new Student("Ron Yang", "555555555", 
                                      "0918555555", 
                                      "Computer Science"));

        // 列印串列中所有的 Student 物件
        int i;
        Iterator iter(sList);
        for (i=0, iter.reset(); iter.hasMoreData(); iter.next(), i++)
        {
            cout << i << ":";
            iter->display(cout);
            cout << endl;
        }
        cout << endl;

        // 檢查是否串列中有兩個學生是在同一個系所的           
        Iterator iter1(sList), iter2(sList);
        for (iter1.reset(); iter1.hasMoreData(); iter1.next())
        {
            for (iter2=iter1, iter2.next(); 
                 iter2.hasMoreData(); iter2.next())
            {
                if (iter1->ofTheSameDepartment(*iter2))
                {
                    cout << "The following two students are "
                             "of the same department:\n";
                    iter1->display(cout);
                    cout << endl;
                    iter2->display(cout);
                    cout << endl;
                }
            }
        }

        // 在 id="333333333" 的學生之後再加入一個學生
        for (iter1.reset(); iter1.hasMoreData(); iter1.next())
            if (iter1->IDEquals("333333333"))
                sList.insertEntry(iter1, 
                                  new Student("Carol Chen", "333331111", 
                                              "0933333111", "Business"));
        for (i=0; i<sList.size(); i++)
            sList[i]->display(cout);
    }

    class Iterator
    {
    public:
        Iterator(StudentList &list);
        void reset();
        void next();
        Student &operator*() const;
        Student *operator->() const;
        bool hasMoreData() const;
    private:
        StudentList::Node *m_iterator;
        StudentList *m_list;
    };

operator->() 是 member access operator, 這是讓一個物件使用起來像是指標的關鍵, 在實作 iterator 或是 Smart pointer 時都需要定義這個成員函式, 在這裡我們設計成讓它傳回目前 m_iterator 所指到的節點所紀錄的 Student 物件指標, 例如:

    Student *Iterator::operator->() const
    {
        if (m_iterator)
            return m_iterator->m_data;
        else
            return 0; // 這個地方請測試並且思考一下回傳 0 會不會造成

    }                     //  member access 的錯誤, 有沒有其它方法? (參考下面說明) 

operator*() 是 dereferencing operator, 它應該要傳回目前指標 m_iterator 所指到的 Student 物件的參考, 例如:

    Student &Iterator::operator*() const
    {
        if (m_iterator)
            return *(m_iterator->m_data);
        else
            return m_dummy;
    }

    class Iterator
    {
        ...
    private:
        static Student m_dummy;
    };
    
    記得要在 iterator.cpp 中定義

    Student Iterator::m_dummy;

傳回目前 StudentList 內 Student 物件的總個數, 這個函式內可以當場去算一遍到底 List 內有幾個節點, 也可以在 StudentList 內實作一個變數來記錄目前總共有幾筆資料, 在 appendEntry() 或是 insertEntry() 時加一, deleteEntry() 時減一

將 StudentList 中第 slot 個節點所記錄的 Student 物件的指標成員的參考傳回, 方便使用這個 StudentList 的模組可以直接修改, 例如:

for (i=0; i<sList.size(); i++)
    if (sList[i]->IDEquals("333333333"))
    {
        delete sList[i];
        sList[i] = new Student("Melany Lee", "333333334", 
                               "0968333333", 
                               "Mechanical Engineering");
        break;
    }

----------------- Iterator.h --------------------
#include "StudentList.h"
class Iterator
{
...
};
---------------- Iterator.cpp -------------------
#include "Iterator.h"
...
--------------- StudentList.h ------------------
class Iterator;
class StudentList
{
...
};
-------------- StudentList.cpp -----------------
#include "StudentList.h"
#include "Iterator.h"
...

請注意

• 什麼時候可以用 forward declaration 呢? 什麼時候一定要 #include 呢?
  Ans: 如果你只需要用 Iterator 來定義一個指標或是參考資料成員, 或是你只是用 Iterator 定義一個函式的參數 (指標/參考/物件) , 你就可以用 forward declatation, 否則需要使用 #include, 另外在 .cpp 中也一定是使用 #include
• 上面各個 include 的順序代表的意義不太一樣, 如果先 #include "Iterator.h" 再 #include "StudentList.h" 則第二個 #include 是沒有做任何事情的, 因為 Iterator.h 裡面已經有 #include "StudentList.h" 了
• 如果你在 class StudentList 中已經有 friend class Iterator; 的敘述, 就可以省掉 前面的 class Iterator; 敘述.
• 請參考 循環依賴與預先宣告

理論上另外一種可能的作法如下, 但是由於 class StudentList::Node; 是一個編譯器在 StudentList 為預先宣告類別時無法接受的敘述, 所以下面這個方式是不成功的

----------------- Iterator.h --------------------
class StudentList;
class StudentList::Node;

class Iterator
{
...
};
---------------- Iterator.cpp -------------------
#include "Iterator.h"
#include "StudentList.h"
...
--------------- StudentList.h ------------------
#include "Iterator.h"
class StudentList
{
...
};
-------------- StudentList.cpp -----------------
#include "StudentList.h"
...

請注意一下一般來說 myClass.h 檔案內到底應該放些什麼東西?

1. 因為 myClass.h 檔案最主要的功能是給 "其它模組" (例如 main.cpp) 引入 class myClass 的定義的, 所以在思考的時候要從其它模組的角度來想
2. 當然 myClass.h 裡最主要的東西是 class myClass 的定義
3. 有的時候也會因為 myClass 和某些其他類別密切結合, 所以會引入那個類別的定義, 例如上述 StudentList.h 可能就會引入 Student.h
4. 很多同學常常會以為 myClass.h 主要是給 myClass.cpp 引入的, 所以把 myClass.cpp 裡面所有需要引入的宣告檔案都引入進來, 例如 myClass.cpp 裡需要 iostream, string, vector, string.h, 所以就在 myClass.h 裡面引入上述, 這是不對的
5. 原則上, myClass.h 檔案裡引入的定義檔案越少越好, 別的模組 xxx.cpp 在引入 myClass.h 時才不會發生意想不到的狀況, 例如 xxx.cpp 明明需要使用 vector, 但是卻看不到 #include <vector> 的敘述, 除了讓編譯器節省一點時間之外, 更重要的原因是減少模組的 依存性 (dependency), 增加模組的可重用性。
6. myClass.h 裡千萬不要放全域變數的定義, 會造成變數的多重定義 (multiple definitions)

最後在編譯你的程式時, 可以先點選個別 .cpp 檔案, 然後使用 建置/編譯 (Ctrl-F7) 來一個一個檔案確定語法以及所引入的檔案是否正確, 如果你使用 建置/建置方案 來編譯你的程式, 常常因為一次編譯多個檔案, 你弄不清楚到底是在編譯哪一個檔案時發生錯誤, 而且如果編譯錯誤發生在引入的檔案中, 因為你的程式裡可能有很多地方都引入相同的檔案, 不容易直接看出來到底是哪裡的語法出錯, 容易誤導你的判斷

檢查兩個學生是不是同一個系所

請注意 Iterator 類別獨立於 StudentList 之外, 在使用時會有點奇怪, 這個 Iterator 類別只能和 StudentList 類別一起用, 也許叫做 StudentListIterator 比較恰當, 或者根本應該宣告在 StudentList 裡面作為一個 public inner class!!

請助教檢查後, 將所完成的 專案 (只需保留 .cpp, .h, .sln 以及 .vcxproj 檔案即可; 刪除掉 .suo, .sdf, .filters, .users, debug\ 資料匣, 以及 ipch\ 資料匣下的所有內容) 壓縮起來, 選擇 Lab10-2 上傳, 後面的實習課程可能需要使用這裡所完成的程式