haiku.git

/*
Open Tracker License

Terms and Conditions

Copyright (c) 1991-2000, Be Incorporated. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice applies to all licensees
and shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF TITLE, MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
BE INCORPORATED BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Be Incorporated shall not be
used in advertising or otherwise to promote the sale, use or other dealings in
this Software without prior written authorization from Be Incorporated.

Tracker(TM), Be(R), BeOS(R), and BeIA(TM) are trademarks or registered trademarks
of Be Incorporated in the United States and other countries. Other brand product
names are registered trademarks or trademarks of their respective holders.
All rights reserved.
*/
#ifndef _OPEN_WITH_WINDOW_H
#define _OPEN_WITH_WINDOW_H


// OpenWithContainerWindow supports the Open With feature


#include <String.h>

#include "ContainerWindow.h"
#include "EntryIterator.h"
#include "NodeWalker.h"
#include "PoseView.h"
#include "Query.h"
#include "SlowMenu.h"
#include "Utilities.h"

class BGroupView;

namespace BPrivate {

enum {
	kUnknownRelation = -1,
	kNoRelation = 0,
	kSuperhandler,
	kSupportsSupertype,
	kSupportsType,
	kPreferredForType,
	kPreferredForFile
};


class OpenWithPoseView;

// pass in a predicate; a query will search for matches
// matches will be returned in iteration
class SearchForSignatureEntryList : public EntryListBase {
public:
	SearchForSignatureEntryList(bool canAddAllApps);
	virtual ~SearchForSignatureEntryList();

	void PushUniqueSignature(const char*);
		// add one signature to search for

	// entry list iterators
	virtual status_t GetNextEntry(BEntry* entry, bool traverse = false);
	virtual status_t GetNextRef(entry_ref* ref);
	virtual int32 GetNextDirents(struct dirent* buffer, size_t length,
		int32 count = INT_MAX);

	virtual status_t Rewind();
	virtual int32 CountEntries();

	bool GetPreferredApp(entry_ref* ref) const;
		// gets the preferred app for all the files it was asked to
		// find supporting apps for, returns false if no preferred app
		// found or if more than one found
	void TrySettingPreferredApp(const entry_ref*);
	void TrySettingPreferredAppForFile(const entry_ref*);

	int32 Relation(const BMessage* entriesToOpen, const Model*) const;
		// returns the reason why an application is shown in
		// Open With window
	void RelationDescription(const BMessage* entriesToOpen, const Model*,
		BString*) const;
		// returns a string describing why application handles files
		// to open

	static int32 Relation(const BMessage* entriesToOpen,
		const Model*, const entry_ref* preferredApp,
		const entry_ref* preferredAppForFile);
		// returns the reason why an application is shown in Open With
		// window static version, needs the preferred app for preformance
	static void RelationDescription(const BMessage* entriesToOpen,
		const Model*, BString*, const entry_ref* preferredApp,
		const entry_ref* preferredAppForFile);
		// returns a string describing why application handles files
		// to open

	bool CanOpenWithFilter(const Model* appModel,
		const BMessage* entriesToOpen, const entry_ref* preferredApp);

	void NonGenericFileFound();
	bool GenericFilesOnly() const;

	bool ShowAllApplications() const;

private:
	static int32 Relation(const Model* node, const Model* app);
		// returns the reason why an application is shown in
		// Open With window

	CachedEntryIteratorList* fIteratorList;
	BStringList fSignatures;

	entry_ref fPreferredRef;
	int32 fPreferredAppCount;
	entry_ref fPreferredRefForFile;
	int32 fPreferredAppForFileCount;
	bool fGenericFilesOnly;
	bool fCanAddAllApps;
	bool fFoundOneNonSuperHandler;
};


class OpenWithContainerWindow : public BContainerWindow {
public:
	OpenWithContainerWindow(BMessage* entriesToOpen,
		LockingList<BWindow>* windowList);
		// <entriesToOpen> eventually get opened by the selected app
	virtual ~OpenWithContainerWindow();

	virtual void Init(const BMessage* message);
	virtual void InitLayout();

	const BMessage* EntryList() const;
		// return the list of the entries we are supposed to open

	void SetCanSetAppAsDefault(bool);
	void SetCanOpen(bool);

	virtual bool ShouldHaveDraggableFolderIcon() { return false; };

	OpenWithPoseView* PoseView() const;

protected:
	virtual BPoseView* NewPoseView(Model* model, uint32 viewMode);

	virtual bool ShouldAddMenus() const;
	virtual void ShowContextMenu(BPoint, const entry_ref*);
	virtual void AddShortcuts();
	virtual void NewAttributesMenu(BMenu*);

	virtual void RestoreState();
	virtual void RestoreState(const BMessage&);
	virtual void RestoreWindowState(AttributeStreamNode*);
	virtual void RestoreWindowState(const BMessage&);
	virtual bool NeedsDefaultStateSetup();
	virtual void SaveState(bool hide = true);
	virtual void SaveState(BMessage&) const;
	virtual void SetupDefaultState();

	virtual bool IsShowing(const node_ref*) const;
	virtual bool IsShowing(const entry_ref*) const;

	virtual void MessageReceived(BMessage*);

	void OpenWithSelection();
		// open entries with the selected app
	void MakeDefaultAndOpen();
		// open entries with the selected app and make it
		// the default handler

private:
	static filter_result KeyDownFilter(BMessage*, BHandler**,
		BMessageFilter*);

	BMessage* fEntriesToOpen;
	BButton* fLaunchButton;
	BButton* fLaunchAndMakeDefaultButton;
	BButton* fCancelButton;

	BGroupView* fButtonContainer;

	typedef BContainerWindow _inherited;
};


class OpenWithPoseView : public BPoseView {
public:
	OpenWithPoseView();
	virtual ~OpenWithPoseView();

	virtual void OpenSelection(BPose*, int32*);
		// open entries with the selected app

	int32 OpenWithRelation(const Model*) const;
		// returns the reason why an application is shown in
		// Open With window
	void OpenWithRelationDescription(const Model*, BString*) const;
		// returns a string describing why application handles files
		// to open

	OpenWithContainerWindow* ContainerWindow() const;

	virtual void AdoptSystemColors();
	virtual bool HasSystemColors() const;

	virtual bool AddPosesThreadValid(const entry_ref*) const;

protected:
	// don't do any volume watching and memtamime watching in open with
	// panels for now
	virtual void InitialStartWatching() {}
	virtual void FinalStopWatching() {}

	virtual EntryListBase* InitDirentIterator(const entry_ref* ref);
	virtual void ReturnDirentIterator(EntryListBase* iterator);
	virtual uint32 WatchNewNodeMask();

	virtual void SetupDefaultColumnsIfNeeded();
		// show launch window specific columns

	// empty overrides for functions that depend on having an fModel
	virtual void SaveState(AttributeStreamNode*);
	virtual void RestoreState(AttributeStreamNode*);
	virtual void SaveState(BMessage&) const;
	virtual void RestoreState(const BMessage&);
	virtual void SavePoseLocations(BRect* = NULL);
	virtual void MoveSelectionToTrash(bool selectNext = true);
	virtual void MoveSelectionTo(BPoint, BPoint, BContainerWindow*);
	virtual void MoveSelectionInto(Model* destFolder,
		BContainerWindow* srcWindow, bool forceCopy,
		bool create_link = false);
	virtual bool HandleMessageDropped(BMessage*);
	virtual bool CanHandleDragSelection(const Model*, const BMessage*,
		bool);

	virtual bool Represents(const node_ref*) const;
	virtual bool Represents(const entry_ref*) const;

	virtual void CreatePoses(Model** models, PoseInfo* poseInfoArray,
		int32 count, BPose** resultingPoses, bool insertionSort = true,
		int32* lastPoseIndexPtr = NULL, BRect* boundsPtr = NULL,
		bool forceDraw = false);
		// override to add selecting the default handling app
		// for selection

	virtual void Pulse();

	virtual void KeyDown(const char* bytes, int32 count);

private:
	entry_ref fPreferredRef;
	bool fHaveCommonPreferredApp;

	SearchForSignatureEntryList* fIterator;
	BRefFilter* fRefFilter;

	typedef BPoseView _inherited;
};


class OpenWithRefFilter: public BRefFilter {
public:
	OpenWithRefFilter(SearchForSignatureEntryList*, const BMessage*,
		entry_ref*);
	bool Filter(const entry_ref* ref, BNode* node, stat_beos* st,
		const char* filetype);

private:
	SearchForSignatureEntryList* fIterator;
	const BMessage *fEntryList;
	entry_ref* fPreferredRef;
};


class RelationCachingModelProxy {
public:
	RelationCachingModelProxy(Model* model);
	~RelationCachingModelProxy();

	int32 Relation(SearchForSignatureEntryList* iterator,
		BMessage* entries) const;

	Model* fModel;
	mutable int32 fRelation;
};


class OpenWithMenu: public BSlowMenu {
public:
	OpenWithMenu(const char* label, const BMessage* entriesToOpen,
		BWindow* parentWindow, BHandler* target);
	OpenWithMenu(const char* label, const BMessage* entriesToOpen,
		BWindow* parentWindow, const BMessenger &target);

private:
	friend int SortByRelation(const RelationCachingModelProxy*,
		const RelationCachingModelProxy*, void*);
	friend int SortByName(const RelationCachingModelProxy*,
		const RelationCachingModelProxy*, void*);
	friend int SortByRelationAndName(const RelationCachingModelProxy*,
		const RelationCachingModelProxy*, void*);

	virtual bool StartBuildingItemList();
	virtual bool AddNextItem();
	virtual void DoneBuildingItemList();
	virtual void ClearMenuBuildingState();

	BMessage fEntriesToOpen;
	BHandler* target;
	BMessenger fMessenger;

	// menu building state
	SearchForSignatureEntryList* fIterator;
	entry_ref fPreferredRef;
	BObjectList<RelationCachingModelProxy, true>* fSupportingAppList;
	bool fHaveCommonPreferredApp;
	BWindow* fParentWindow;

	typedef BSlowMenu _inherited;
};


// used for optionally showing the list of all apps. Do nothing
// until asked to iterate and only if supposed to do so
class ConditionalAllAppsIterator : public EntryListBase {
public:
	ConditionalAllAppsIterator(SearchForSignatureEntryList* parent);
	~ConditionalAllAppsIterator();

	virtual status_t GetNextEntry(BEntry* entry, bool traverse = false);
	virtual status_t GetNextRef(entry_ref* ref);
	virtual int32 GetNextDirents(struct dirent* buffer, size_t length,
		int32 count = INT_MAX);

	virtual status_t Rewind();
	virtual int32 CountEntries();

protected:
	bool Iterate() const;
	void Instantiate();

private:
	SearchForSignatureEntryList* fParent;
	BTrackerPrivate::TWalker* fWalker;
};

} // namespace BPrivate

using namespace BPrivate;


#endif	// _OPEN_WITH_WINDOW_H