summaryrefslogtreecommitdiffstats
path: root/macosx/HBOutputPanelController.m
blob: ecfcc7de77a94d7e60fa8acbf36060bbf385b8b0 (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*  HBOutputPanelController.m

 This file is part of the HandBrake source code.
 Homepage: <http://handbrake.fr/>.
 It may be used under the terms of the GNU General Public License. */

#import "HBOutputPanelController.h"
#import "HBOutputRedirect.h"
#import "HBOutputFileWriter.h"
#import "HBUtilities.h"

/// Maximum amount of characters that can be shown in the view.
#define TextStorageUpperSizeLimit 125000

/// When old output is removed, this is the amount of characters that will be
/// left in outputTextStorage.
#define TextStorageLowerSizeLimit 120000

@interface HBOutputPanelController () <HBOutputRedirectListening>

/// Textview that displays debug output.
@property (nonatomic, unsafe_unretained) IBOutlet NSTextView *textView;

/// Text storage for the debug output.
@property (nonatomic, readonly) NSTextStorage *outputTextStorage;
@property (nonatomic, readonly) NSDictionary *textAttributes;

/// Path to log text file.
@property (nonatomic, copy, readonly) HBOutputFileWriter *outputFile;

@end

@implementation HBOutputPanelController

/**
 * Initializes the object, creates outputTextStorage and starts redirection of stderr.
 */
- (instancetype)init
{
    if( (self = [super initWithWindowNibName:@"OutputPanel"]) )
    {
        // We initialize the outputTextStorage object for the activity window
        _outputTextStorage = [[NSTextStorage alloc] init];

        // Text attributes
        _textAttributes = @{NSForegroundColorAttributeName: NSColor.textColor};

        // Add ourself as stderr/stdout listener
        [HBOutputRedirect.stderrRedirect addListener:self queue:dispatch_get_main_queue()];
        [HBOutputRedirect.stdoutRedirect addListener:self queue:dispatch_get_main_queue()];

        // Redirect the output to a file on the disk.
        NSURL *outputLogFile = [HBUtilities.appSupportURL URLByAppendingPathComponent:@"HandBrake-activitylog.txt"];

        _outputFile = [[HBOutputFileWriter alloc] initWithFileURL:outputLogFile];
        if (_outputFile)
        {
            [HBOutputRedirect.stderrRedirect addListener:_outputFile queue:dispatch_get_main_queue()];
            [HBOutputRedirect.stdoutRedirect addListener:_outputFile queue:dispatch_get_main_queue()];
        }

        [self writeHeader];
    }
    return self;
}

- (void)dealloc
{
    [HBOutputRedirect.stderrRedirect removeListener:self];
    [HBOutputRedirect.stdoutRedirect removeListener:self];
}

- (void)windowDidLoad
{
    [super windowDidLoad];

    [_textView.layoutManager replaceTextStorage:_outputTextStorage];
    [_textView.enclosingScrollView setLineScroll:10];
    [_textView.enclosingScrollView setPageScroll:20];

    [_textView scrollToEndOfDocument:self];
}

- (IBAction)showWindow:(id)sender
{
    [_textView scrollToEndOfDocument:self];
    [super showWindow:sender];
}

/**
 Write the HandBrake version number to the log
 */
- (void)writeHeader
{
    NSDictionary *infoDict = NSBundle.mainBundle.infoDictionary;
    NSString *versionStringFull = [NSString stringWithFormat:@"Handbrake Version: %@ (%@)", infoDict[@"CFBundleShortVersionString"], infoDict[@"CFBundleVersion"]];
    [HBUtilities writeToActivityLog:"%s", versionStringFull.UTF8String];
}

/**
 * Displays text received from HBOutputRedirect in the text view
 */
- (void)redirect:(NSString *)text type:(HBRedirectType)type
{
    NSAttributedString *attributedString = [[NSAttributedString alloc] initWithString:text attributes:_textAttributes];
	// Actually write the libhb output to the text view (outputTextStorage)
    [_outputTextStorage appendAttributedString:attributedString];

	// remove text from outputTextStorage as defined by TextStorageUpperSizeLimit and TextStorageLowerSizeLimit */
    if (_outputTextStorage.length > TextStorageUpperSizeLimit)
    {
		[_outputTextStorage deleteCharactersInRange:NSMakeRange(0, _outputTextStorage.length - TextStorageLowerSizeLimit)];
    }

    if (self.windowLoaded && self.window.isVisible)
    {
        [_textView scrollToEndOfDocument:self];
    }
}

/**
 * Clears the output window.
 */
- (IBAction)clearOutput:(id)sender
{
	[_outputTextStorage deleteCharactersInRange:NSMakeRange(0, _outputTextStorage.length)];
    [self writeHeader];
}

/**
 * Copies all text in the output window to pasteboard.
 */
- (IBAction)copyAllOutputToPasteboard:(id)sender
{
	NSPasteboard *pboard = NSPasteboard.generalPasteboard;
    [pboard declareTypes:@[NSPasteboardTypeString] owner:nil];
    [pboard setString:_outputTextStorage.string forType:NSPasteboardTypeString];
}

/**
 * Opens the activity log txt file in users default editor.
 */
- (IBAction)openActivityLogFile:(id)sender
{
    [NSWorkspace.sharedWorkspace openURL:self.outputFile.url];
}

/**
 * Opens the activity log txt file in users default editor.
 */
- (IBAction)openEncodeLogDirectory:(id)sender
{
    // Opens the activity window log file in the users default text editor
    NSURL *encodeLogDirectory = [HBUtilities.appSupportURL URLByAppendingPathComponent:@"EncodeLogs"];
    if (![NSFileManager.defaultManager fileExistsAtPath:encodeLogDirectory.path])
    {
        [NSFileManager.defaultManager createDirectoryAtPath:encodeLogDirectory.path
                                withIntermediateDirectories:NO
                                                 attributes:nil
                                                      error:nil];
    }
    [NSWorkspace.sharedWorkspace openURL:encodeLogDirectory];
}

- (IBAction)clearActivityLogFile:(id)sender
{
    [self.outputFile clear];
}

@end