xref: /haiku/src/kits/tracker/OpenWithWindow.h (revision 644fa5a93845dc4a1bc155f1fd0f94ebdf0b47bc)
1 /*
2 Open Tracker License
3 
4 Terms and Conditions
5 
6 Copyright (c) 1991-2000, Be Incorporated. All rights reserved.
7 
8 Permission is hereby granted, free of charge, to any person obtaining a copy of
9 this software and associated documentation files (the "Software"), to deal in
10 the Software without restriction, including without limitation the rights to
11 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12 of the Software, and to permit persons to whom the Software is furnished to do
13 so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice applies to all licensees
16 and shall be included in all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF TITLE, MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 BE INCORPORATED BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
23 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 
25 Except as contained in this notice, the name of Be Incorporated shall not be
26 used in advertising or otherwise to promote the sale, use or other dealings in
27 this Software without prior written authorization from Be Incorporated.
28 
29 Tracker(TM), Be(R), BeOS(R), and BeIA(TM) are trademarks or registered trademarks
30 of Be Incorporated in the United States and other countries. Other brand product
31 names are registered trademarks or trademarks of their respective holders.
32 All rights reserved.
33 */
34 #ifndef _OPEN_WITH_WINDOW_H
35 #define _OPEN_WITH_WINDOW_H
36 
37 
38 // OpenWithContainerWindow supports the Open With feature
39 
40 
41 #include <String.h>
42 
43 #include "ContainerWindow.h"
44 #include "EntryIterator.h"
45 #include "NodeWalker.h"
46 #include "PoseView.h"
47 #include "Query.h"
48 #include "SlowMenu.h"
49 #include "Utilities.h"
50 
51 class BGroupView;
52 
53 namespace BPrivate {
54 
55 enum {
56 	kUnknownRelation = -1,
57 	kNoRelation = 0,
58 	kSuperhandler,
59 	kSupportsSupertype,
60 	kSupportsType,
61 	kPreferredForType,
62 	kPreferredForFile
63 };
64 
65 
66 class OpenWithPoseView;
67 
68 // pass in a predicate; a query will search for matches
69 // matches will be returned in iteration
70 class SearchForSignatureEntryList : public EntryListBase {
71 public:
72 	SearchForSignatureEntryList(bool canAddAllApps);
73 	virtual ~SearchForSignatureEntryList();
74 
75 	void PushUniqueSignature(const char*);
76 		// add one signature to search for
77 
78 	// entry list iterators
79 	virtual status_t GetNextEntry(BEntry* entry, bool traverse = false);
80 	virtual status_t GetNextRef(entry_ref* ref);
81 	virtual int32 GetNextDirents(struct dirent* buffer, size_t length,
82 		int32 count = INT_MAX);
83 
84 	virtual status_t Rewind();
85 	virtual int32 CountEntries();
86 
87 	bool GetPreferredApp(entry_ref* ref) const;
88 		// gets the preferred app for all the files it was asked to
89 		// find supporting apps for, returns false if no preferred app
90 		// found or if more than one found
91 	void TrySettingPreferredApp(const entry_ref*);
92 	void TrySettingPreferredAppForFile(const entry_ref*);
93 
94 	int32 Relation(const BMessage* entriesToOpen, const Model*) const;
95 		// returns the reason why an application is shown in
96 		// Open With window
97 	void RelationDescription(const BMessage* entriesToOpen, const Model*,
98 		BString*) const;
99 		// returns a string describing why application handles files
100 		// to open
101 
102 	static int32 Relation(const BMessage* entriesToOpen,
103 		const Model*, const entry_ref* preferredApp,
104 		const entry_ref* preferredAppForFile);
105 		// returns the reason why an application is shown in Open With
106 		// window static version, needs the preferred app for preformance
107 	static void RelationDescription(const BMessage* entriesToOpen,
108 		const Model*, BString*, const entry_ref* preferredApp,
109 		const entry_ref* preferredAppForFile);
110 		// returns a string describing why application handles files
111 		// to open
112 
113 	bool CanOpenWithFilter(const Model* appModel,
114 		const BMessage* entriesToOpen, const entry_ref* preferredApp);
115 
116 	void NonGenericFileFound();
117 	bool GenericFilesOnly() const;
118 
119 	bool ShowAllApplications() const;
120 
121 private:
122 	static int32 Relation(const Model* node, const Model* app);
123 		// returns the reason why an application is shown in
124 		// Open With window
125 
126 	CachedEntryIteratorList* fIteratorList;
127 	BObjectList<BString> fSignatures;
128 
129 	entry_ref fPreferredRef;
130 	int32 fPreferredAppCount;
131 	entry_ref fPreferredRefForFile;
132 	int32 fPreferredAppForFileCount;
133 	bool fGenericFilesOnly;
134 	bool fCanAddAllApps;
135 	bool fFoundOneNonSuperHandler;
136 };
137 
138 
139 class OpenWithContainerWindow : public BContainerWindow {
140 public:
141 	OpenWithContainerWindow(BMessage* entriesToOpen,
142 		LockingList<BWindow>* windowList);
143 		// <entriesToOpen> eventually get opened by the selected app
144 	virtual ~OpenWithContainerWindow();
145 
146 	virtual void Init(const BMessage* message);
147 	virtual void InitLayout();
148 
149 	const BMessage* EntryList() const;
150 		// return the list of the entries we are supposed to open
151 
152 	void SetCanSetAppAsDefault(bool);
153 	void SetCanOpen(bool);
154 
155 	OpenWithPoseView* PoseView() const;
156 
157 protected:
158 	virtual BPoseView* NewPoseView(Model* model, uint32 viewMode);
159 
160 	virtual	bool ShouldAddMenus() const;
161 	virtual	void ShowContextMenu(BPoint, const entry_ref*, BView*);
162 	virtual void AddShortcuts();
163 	virtual void NewAttributeMenu(BMenu*);
164 
165 	virtual void RestoreState();
166 	virtual	void RestoreState(const BMessage&);
167 	virtual void RestoreWindowState(AttributeStreamNode*);
168 	virtual void RestoreWindowState(const BMessage&);
169 	virtual bool NeedsDefaultStateSetup();
170 	virtual	void SaveState(bool hide = true);
171 	virtual	void SaveState(BMessage&) const;
172 	virtual void SetUpDefaultState();
173 
174 	virtual bool IsShowing(const node_ref*) const;
175 	virtual bool IsShowing(const entry_ref*) const;
176 
177 	virtual void MessageReceived(BMessage*);
178 
179 	void OpenWithSelection();
180 		// open entries with the selected app
181 	void MakeDefaultAndOpen();
182 		// open entries with the selected app and make it
183 		// the default handler
184 
185 private:
186 	static filter_result KeyDownFilter(BMessage*, BHandler**,
187 		BMessageFilter*);
188 
189 	BMessage* fEntriesToOpen;
190 	BButton* fLaunchButton;
191 	BButton* fLaunchAndMakeDefaultButton;
192 	BButton* fCancelButton;
193 
194 	BGroupView* fButtonContainer;
195 
196 	typedef BContainerWindow _inherited;
197 };
198 
199 
200 class OpenWithPoseView : public BPoseView {
201 public:
202 	OpenWithPoseView();
203 
204 	virtual void OpenSelection(BPose*, int32*);
205 		// open entries with the selected app
206 
207 	int32 OpenWithRelation(const Model*) const;
208 		// returns the reason why an application is shown in
209 		// Open With window
210 	void OpenWithRelationDescription(const Model*, BString*) const;
211 		// returns a string describing why application handles files
212 		// to open
213 
214 	OpenWithContainerWindow* ContainerWindow() const;
215 
216 	virtual bool AddPosesThreadValid(const entry_ref*) const;
217 
218 protected:
219 	// don't do any volume watching and memtamime watching in open with
220 	// panels for now
221 	virtual void InitialStartWatching() {}
222 	virtual void FinalStopWatching() {}
223 
224 	virtual void AttachedToWindow();
225 	EntryListBase* InitDirentIterator(const entry_ref* ref);
226 
227 	virtual void SetUpDefaultColumnsIfNeeded();
228 		// show launch window specific columns
229 
230 	// empty overrides for functions that depend on having an fModel
231 	virtual void SaveState(AttributeStreamNode*);
232 	virtual void RestoreState(AttributeStreamNode*);
233 	virtual void SaveState(BMessage&) const;
234 	virtual void RestoreState(const BMessage&);
235 	virtual void SavePoseLocations(BRect* = NULL);
236 	virtual void MoveSelectionToTrash(bool selectNext = true);
237 	virtual void MoveSelectionTo(BPoint, BPoint, BContainerWindow*);
238 	virtual void MoveSelectionInto(Model* destFolder,
239 		BContainerWindow* srcWindow, bool forceCopy,
240 		bool create_link = false);
241 	virtual bool HandleMessageDropped(BMessage*);
242 	virtual bool CanHandleDragSelection(const Model*, const BMessage*,
243 		bool);
244 
245 	virtual bool Represents(const node_ref*) const;
246 	virtual bool Represents(const entry_ref*) const;
247 
248 	virtual void CreatePoses(Model** models, PoseInfo* poseInfoArray,
249 		int32 count, BPose** resultingPoses, bool insertionSort = true,
250 		int32* lastPoseIndexPtr = NULL, BRect* boundsPtr = NULL,
251 		bool forceDraw = false);
252 		// override to add selecting the default handling app
253 		// for selection
254 
255 	virtual void Pulse();
256 
257 	virtual void KeyDown(const char* bytes, int32 count);
258 
259 private:
260 	entry_ref fPreferredRef;
261 	bool fHaveCommonPreferredApp;
262 
263 	SearchForSignatureEntryList* fIterator;
264 		// private copy of the iterator pointer
265 
266 	typedef BPoseView _inherited;
267 };
268 
269 
270 class OpenWithRefFilter: public BRefFilter {
271 public:
272 	OpenWithRefFilter(SearchForSignatureEntryList*, const BMessage*,
273 		entry_ref*);
274 	bool Filter(const entry_ref* ref, BNode* node, stat_beos* st,
275 		const char* filetype);
276 
277 private:
278 	SearchForSignatureEntryList* fIterator;
279 	const BMessage *fEntryList;
280 	entry_ref* fPreferredRef;
281 };
282 
283 
284 class RelationCachingModelProxy {
285 public:
286 	RelationCachingModelProxy(Model* model);
287 	~RelationCachingModelProxy();
288 
289 	int32 Relation(SearchForSignatureEntryList* iterator,
290 		BMessage* entries) const;
291 
292 	Model* fModel;
293 	mutable int32 fRelation;
294 };
295 
296 
297 class OpenWithMenu : public BSlowMenu {
298 public:
299 	OpenWithMenu(const char* label, const BMessage* entriesToOpen,
300 		BWindow* parentWindow, BHandler* target);
301 	OpenWithMenu(const char* label, const BMessage* entriesToOpen,
302 		BWindow* parentWindow, const BMessenger &target);
303 
304 private:
305 	friend int SortByRelationAndName(const RelationCachingModelProxy*,
306 		const RelationCachingModelProxy*, void*);
307 
308 	virtual bool StartBuildingItemList();
309 	virtual bool AddNextItem();
310 	virtual void DoneBuildingItemList();
311 	virtual void ClearMenuBuildingState();
312 
313 	BMessage fEntriesToOpen;
314 	BHandler* target;
315 	BMessenger fMessenger;
316 
317 	// menu building state
318 	SearchForSignatureEntryList* fIterator;
319 	entry_ref fPreferredRef;
320 	BObjectList<RelationCachingModelProxy>* fSupportingAppList;
321 	bool fHaveCommonPreferredApp;
322 	BWindow* fParentWindow;
323 
324 	typedef BSlowMenu _inherited;
325 };
326 
327 
328 // used for optionally showing the list of all apps. Do nothing
329 // until asked to iterate and only if supposed to do so
330 class ConditionalAllAppsIterator : public EntryListBase {
331 public:
332 	ConditionalAllAppsIterator(SearchForSignatureEntryList* parent);
333 	~ConditionalAllAppsIterator();
334 
335 	virtual status_t GetNextEntry(BEntry* entry, bool traverse = false);
336 	virtual status_t GetNextRef(entry_ref* ref);
337 	virtual int32 GetNextDirents(struct dirent* buffer, size_t length,
338 		int32 count = INT_MAX);
339 
340 	virtual status_t Rewind();
341 	virtual int32 CountEntries();
342 
343 protected:
344 	bool Iterate() const;
345 	void Instantiate();
346 
347 private:
348 	SearchForSignatureEntryList* fParent;
349 	BTrackerPrivate::TWalker* fWalker;
350 };
351 
352 } // namespace BPrivate
353 
354 using namespace BPrivate;
355 
356 
357 #endif	// _OPEN_WITH_WINDOW_H
358