Ticket #6257: layoutArchiving.patch

src/kits/interface/Layout.cpp

@@ -1 +1 @@
 /*
+ * Copyright 2010, Haiku Inc.
  * Copyright 2006, Ingo Weinhold <bonefish@cs.tu-berlin.de>.
  * All rights reserved. Distributed under the terms of the MIT License.
  */
@@ -13 +14 @@
 
 using std::nothrow;
 
+namespace {
+    const char* kLayoutItemArchiveField = "_items";
+}
 
+
 // constructor
 BLayout::BLayout()
-    : fView(NULL),
-      fItems(20)
+    :
+    fView(NULL),
+    fItems(20)
 {
 }
 
+// archive constructor
+BLayout::BLayout(BMessage* from)
+    :
+    BArchivable(BUnarchiver::PrepareArchive(from)),
+    fView(NULL),
+    fItems(20)
+{
+    BUnarchiver unarchiver(from);
+
+    for (int32 i = 0;
+        unarchiver.EnsureUnarchived(kLayoutItemArchiveField, i) == B_OK;
+        i++)
+        ;
+}
+
 // destructor
 BLayout::~BLayout()
 {
@@ -153 +174 @@
 
 // IndexOfItem
 int32
-BLayout::IndexOfItem(BLayoutItem* item) const
+BLayout::IndexOfItem(const BLayoutItem* item) const
 {
     return fItems.IndexOf(item);
 }
@@ -180 +201 @@
         fView->InvalidateLayout();
 }
 
+// Archive
+status_t
+BLayout::Archive(BMessage* into, bool deep) const
+{
+    BArchiver archiver(BArchiver::PrepareArchive(into));
+    status_t err = BArchivable::Archive(into, deep);
+
+    if (err != B_OK)
+        return err;
+    
+    if (deep) {
+        int32 count = CountItems();
+        for (int32 i = 0; i < count; i++) {
+            err = archiver.AddArchivable(kLayoutItemArchiveField,
+                ItemAt(i), deep);
+
+            if (err != B_OK)
+                return err;
+        }
+    }
+
+    return B_OK;
+}
+
+// AllUnarchived
+status_t
+BLayout::AllUnarchived(const BMessage* from)
+{
+    return BArchivable::AllUnarchived(from);
+
+    // BLayoutItems call RestoreItemAndData() in their AllUnarchived().
+    // and get added there.
+}
+
+// ArchiveLayoutData
+status_t
+BLayout::ArchiveLayoutData(BMessage* into, const BLayoutItem* of)
+{
+    return B_OK;
+}
+
+// RestoreItemAndData
+status_t
+BLayout::RestoreItemAndData(const BMessage* from, BLayoutItem* item)
+{
+    return B_OK;
+}
+
 // ItemAdded
 void
 BLayout::ItemAdded(BLayoutItem* item)

src/kits/interface/LayoutItem.cpp

@@ -1 +1 @@
 /*
+ * Copyright 2010, Haiku, Inc.
  * Copyright 2006, Ingo Weinhold <bonefish@cs.tu-berlin.de>.
  * All rights reserved. Distributed under the terms of the MIT License.
  */
@@ -8 +9 @@
 #include <Layout.h>
 #include <LayoutUtils.h>
 
+namespace {
+    const char* kLayoutArchiveField = "layout";
+}
 
 // constructor
 BLayoutItem::BLayoutItem()
-    : fLayout(NULL),
-      fLayoutData(NULL)
+    :
+    fLayout(NULL),
+    fLayoutData(NULL)
 {
 }
 
+// archive constructor
+BLayoutItem::BLayoutItem(BMessage* from)
+    :
+    BArchivable(BUnarchiver::PrepareArchive(from)),
+    fLayout(NULL),
+    fLayoutData(NULL)
+{
+    BUnarchiver(from).EnsureUnarchived(kLayoutArchiveField);
+}
+
 // destructor
 BLayoutItem::~BLayoutItem()
 {
@@ -101 +116 @@
     SetFrame(BLayoutUtils::AlignInFrame(frame, maxSize, alignment));
 }
 
+// Archive
+status_t
+BLayoutItem::Archive(BMessage* into, bool deep) const
+{
+    BArchiver archiver(BArchiver::PrepareArchive(into));
+    BArchivable::Archive(into, deep);
+
+    archiver.AddOptional(kLayoutArchiveField, fLayout);
+
+    status_t err = B_OK;
+    if (fLayout)
+        err = fLayout->ArchiveLayoutData(into, this);
+
+    return err;
+}
+
+// AllUnarchived
+status_t
+BLayoutItem::AllUnarchived(const BMessage* from)
+{
+    BUnarchiver unarchiver(from);
+    BArchivable* retriever;
+
+    status_t err = B_OK;
+
+    if (unarchiver.FindArchivable(kLayoutArchiveField, &retriever) == B_OK) {
+        BLayout* layout = dynamic_cast<BLayout*>(retriever);
+        if (layout)
+            err = layout->RestoreItemAndData(from, this);
+    }
+
+    return err;
+}
+
 // SetLayout
 void
 BLayoutItem::SetLayout(BLayout* layout)

headers/os/interface/Layout.h

@@ -1 +1 @@
 /*
- * Copyright 2006, Haiku, Inc. All rights reserved.
+ * Copyright 2006-2010, Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _LAYOUT_H
 #define _LAYOUT_H
 
 #include <Alignment.h>
+#include <Archivable.h>
 #include <List.h>
 #include <Size.h>
 
@@ -13 +14 @@
 class BView;
 
 
-class BLayout {
+class BLayout: public BArchivable {
 public:
                                 BLayout();
+                                BLayout(BMessage* archive);
     virtual                     ~BLayout();
 
             BView*              View() const;
@@ -32 +34 @@
 
             BLayoutItem*        ItemAt(int32 index) const;
             int32               CountItems() const;
-            int32               IndexOfItem(BLayoutItem* item) const;
+            int32               IndexOfItem(const BLayoutItem* item) const;
             int32               IndexOfView(BView* child) const;
 
     virtual BSize               MinSize() = 0;
@@ -48 +50 @@
 
     virtual void                LayoutView() = 0;
 
+    virtual status_t            Archive(BMessage* into, bool deep = true) const;
+    virtual status_t            AllUnarchived(const BMessage* from);
+    virtual status_t            ArchiveLayoutData(BMessage* into,
+                                    const BLayoutItem* of);
+    virtual status_t            RestoreItemAndData(const BMessage* from,
+                                    BLayoutItem* item);
+
 protected:
+
 // TODO: Since memory allocations can fail, we should return a bool and
 // undo the addition, if false.
     virtual void                ItemAdded(BLayoutItem* item);

headers/os/interface/LayoutItem.h

@@ -1 +1 @@
 /*
- * Copyright 2006, Haiku, Inc. All rights reserved.
+ * Copyright 2006-2010, Haiku, Inc. All rights reserved.
  * Distributed under the terms of the MIT License.
  */
 #ifndef _LAYOUT_ITEM_H
 #define _LAYOUT_ITEM_H
 
 #include <Alignment.h>
+#include <Archivable.h>
 #include <Rect.h>
 #include <Size.h>
 
 class BLayout;
 class BView;
 
-class BLayoutItem {
+class BLayoutItem: public BArchivable {
 public:
                                 BLayoutItem();
+                                BLayoutItem(BMessage* from);
     virtual                     ~BLayoutItem();
 
             BLayout*            Layout() const;
@@ -47 +49 @@
             void                SetLayoutData(void* data);
 
             void                AlignInFrame(BRect frame);
+
+    virtual status_t            Archive(BMessage* into, bool deep = true) const;
+    virtual status_t            AllUnarchived(const BMessage* from);
     
+    
 private:
             friend class BLayout;