summaryrefslogtreecommitdiff
path: root/Sources/Data/OwlDataSource.h
blob: a9236b7cfdf70a269317dfc37294627e66e4fee0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/* This file is part of Owl.
 *
 * Copyright © 2019-2021 Sergey Bugaev <bugaevc@gmail.com>
 *
 * Owl is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * Owl is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Owl.  If not, see <http://www.gnu.org/licenses/>.
 */

#import <Cocoa/Cocoa.h>
#import <wayland-server.h>

@class OwlDataSource;

// Something that keeps a reference to a data source.
//
// A data source can conceptually die at any moment, but the object
// can only be deallocated once all the references to it are gone.
// To make this work, data sources notify the interested parties of their
// death, asking them to drop their reference. Once they all do, the data
// source gets deallocated.
//
// In addition to implementing -releaseDataSource:, data source holders
// should call -addHolder: and -removeHolder: as appropriate, to help the
// data source maintain an up-to-date list of its holders.
@protocol OwlDataSourceHolder
- (void) releaseDataSource: (OwlDataSource *) source;
@end


// A data source represents a lazily-received piece of data, perhaps
// available in several formats, such as plain and rich text.
//
// Typically, it's a client that actually has the data represented by a
// data source.
@interface OwlDataSource : NSObject {
    struct wl_resource *_resource;
    NSMutableArray *_mimeTypes;
    NSMutableArray *_holders;
}

- (id) initWithResource: (struct wl_resource *) resource;

- (NSArray *) mimeTypes;

// Data source holder management.
- (void) addHolder: (id<OwlDataSourceHolder>) holder;
- (void) removeHolder: (id<OwlDataSourceHolder>) holder;
- (void) releaseFromHolders;

// Subclasses should override these.
- (void) sendContentOfMimeType: (NSString *) mimeType
                  toFileHandle: (NSFileHandle *) fileHandle;
- (void) sendCancelled;

@end