Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

693 lines (598 sloc) 18.971 kb
// -*- mode:objc -*-
/*
** Popup.m
**
** Copyright 20101
**
** Author: George Nachman
**
** Project: iTerm2
**
** Description: Base classes for popup windows like autocomplete and
** pasteboardhistory.
**
** This program 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 2 of the License, or
** (at your option) any later version.
**
** This program 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 this program; if not, write to the Free Software
** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#import "Popup.h"
#import "VT100Screen.h"
#import "PTYTextView.h"
#include <wctype.h>
#import "iTermApplicationDelegate.h"
#import "PTYTab.h"
#ifdef POPUP_VERBOSE_LOGGING
#define PopLog NSLog
#else
#define PopLog(args...) \
do { \
if (gDebugLogging) { \
DebugLog([NSString stringWithFormat:args]); \
} \
} while (0)
#endif
@implementation PopupEntry
- (void)_setDefaultValues
{
hitMultiplier_ = 1;
[self setMainValue:@""];
[self setScore:0];
[self setPrefix:@""];
}
- (id)init
{
self = [super init];
if (!self) {
return self;
}
[self _setDefaultValues];
return self;
}
+ (PopupEntry*)entryWithString:(NSString*)s score:(double)score
{
PopupEntry* e = [[[PopupEntry alloc] init] autorelease];
[e _setDefaultValues];
[e setMainValue:s];
[e setScore:score];
return e;
}
- (NSString*)mainValue
{
return s_;
}
- (void)setScore:(double)score
{
score_ = score;
}
- (void)setMainValue:(NSString*)s
{
[s_ autorelease];
s_ = [s retain];
}
- (double)advanceHitMult
{
hitMultiplier_ *= 0.8;
return hitMultiplier_;
}
- (double)score
{
return score_;
}
- (BOOL)isEqual:(id)o
{
if ([o respondsToSelector:@selector(mainValue)]) {
return [[self mainValue] isEqual:[o mainValue]];
} else {
return [super isEqual:o];
}
}
- (NSComparisonResult)compare:(id)otherObject
{
return [[NSNumber numberWithDouble:score_] compare:[NSNumber numberWithDouble:[otherObject score]]];
}
- (void)setPrefix:(NSString*)prefix
{
[prefix_ autorelease];
prefix_ = [prefix retain];
}
- (NSString*)prefix
{
return prefix_;
}
@end
@implementation PopupWindow
- (id)initWithContentRect:(NSRect)contentRect
styleMask:(NSUInteger)aStyle
backing:(NSBackingStoreType)bufferingType
defer:(BOOL)flag
{
self = [super initWithContentRect:contentRect
styleMask:NSBorderlessWindowMask
backing:bufferingType
defer:flag];
[self setCollectionBehavior:NSWindowCollectionBehaviorMoveToActiveSpace];
return self;
}
- (BOOL)canBecomeKeyWindow
{
return YES;
}
- (void)keyDown:(NSEvent *)event
{
id cont = [self windowController];
if (cont && [cont respondsToSelector:@selector(keyDown:)]) {
[cont keyDown:event];
}
}
- (void)shutdown
{
shutdown_ = YES;
}
- (void)setParentWindow:(NSWindow*)parentWindow
{
parentWindow_ = parentWindow;
}
- (void)close
{
if (shutdown_) {
[super close];
} else {
// The OS will send a hotkey window to the background if it's open and in
// all spaces. Make it key before closing. This has to be done later because if you do it
// here the OS gets confused and two windows are key.
//NSLog(@"Perform delayed selector with target %@", self);
[self performSelector:@selector(twiddleKeyWindow)
withObject:self
afterDelay:0];
}
}
- (void)twiddleKeyWindow
{
iTermApplicationDelegate* theDelegate = [NSApp delegate];
[theDelegate makeHotKeyWindowKeyIfOpen];
[super close];
[parentWindow_ makeKeyAndOrderFront:self];
}
@end
@implementation PopupModel
- (id)init
{
self = [super init];
if (!self) {
return self;
}
maxEntries_ = -1;
values_ = [[NSMutableArray alloc] init];
return self;
}
- (id)initWithMaxEntries:(int)maxEntries
{
self = [super init];
if (!self) {
return self;
}
maxEntries_ = maxEntries;
values_ = [[NSMutableArray alloc] init];
return self;
}
- (void)dealloc
{
[values_ release];
[super dealloc];
}
- (NSUInteger)count
{
return [values_ count];
}
- (void)removeAllObjects
{
[values_ removeAllObjects];
}
- (void)addObject:(id)object
{
[values_ addObject:object];
}
- (PopupEntry*)entryEqualTo:(PopupEntry*)entry
{
for (PopupEntry* candidate in values_) {
if ([candidate isEqual:entry]) {
return candidate;
}
}
return nil;
}
- (void)addHit:(PopupEntry*)object
{
PopupEntry* entry = [self entryEqualTo:object];
if (entry) {
[entry setScore:[entry score] + [object score] * [entry advanceHitMult]];
PopLog(@"Add additional hit for %@ bringing score to %lf", [entry mainValue], [entry score]);
} else if (maxEntries_ < 0 || [self count] < maxEntries_) {
[self addObject:object];
PopLog(@"Add entry for %@ with score %lf", [object mainValue], [object score]);
} else {
PopLog(@"Not adding entry because max of %u hit", maxEntries_);
}
}
- (id)objectAtIndex:(NSUInteger)i
{
return [values_ objectAtIndex:i];
}
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)stackbuf count:(NSUInteger)len
{
return [values_ countByEnumeratingWithState:state objects:stackbuf count:len];
}
- (NSUInteger)indexOfObject:(id)o
{
return [values_ indexOfObject:o];
}
- (void)sortByScore
{
NSSortDescriptor *sortDescriptor;
sortDescriptor = [[[NSSortDescriptor alloc] initWithKey:@"score"
ascending:NO] autorelease];
NSArray *sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
NSArray *sortedArray;
sortedArray = [values_ sortedArrayUsingDescriptors:sortDescriptors];
[values_ release];
values_ = [[NSMutableArray arrayWithArray:sortedArray] retain];
}
- (int)indexOfObjectWithMainValue:(NSString*)value
{
for (int i = 0; i < [values_ count]; ++i) {
PopupEntry* entry = [values_ objectAtIndex:i];
if ([[entry mainValue] isEqualToString:value]) {
return i;
}
}
return -1;
}
@end
@implementation Popup
- (id)initWithWindowNibName:(NSString*)nibName tablePtr:(NSTableView**)table model:(PopupModel*)model;
{
self = [super initWithWindowNibName:nibName];
if (!self) {
return self;
}
[self window];
tableView_ = [*table retain];
model_ = [[PopupModel alloc] init];
substring_ = [[NSMutableString alloc] init];
unfilteredModel_ = [model retain];
selectionMainValue_ = [[NSMutableString alloc] init];
return self;
}
- (void)dealloc
{
[selectionMainValue_ release];
[unfilteredModel_ release];
[substring_ release];
[model_ release];
[tableView_ release];
[session_ release];
[super dealloc];
}
- (void)shutdown
{
// Disable the fancy footwork in -[PopupWindow close]
[(PopupWindow*)[self window] shutdown];
// Prevent twiddleKeyWindow from running after parent window is dealloc'ed.
[NSObject cancelPreviousPerformRequestsWithTarget:[self window]];
// Force the window to close immediately.
[self close];
}
- (BOOL)disableFocusFollowsMouse
{
return YES;
}
- (void)popInSession:(PTYSession*)session
{
[[self window] setParentWindow:[[[session tab] realParentWindow] window]];
[self setSession:session];
[self showWindow:[[session tab] parentWindow]];
[[self window] makeKeyAndOrderFront:[[session tab] parentWindow]];
}
- (void)setSession:(PTYSession*)session
{
[session_ autorelease];
session_ = [session retain];
}
- (PTYSession*)session
{
return session_;
}
- (PopupModel*)unfilteredModel
{
return unfilteredModel_;
}
- (PopupModel*)model
{
return model_;
}
- (void)onClose
{
clearFilterOnNextKeyDown_ = NO;
if (timer_) {
[timer_ invalidate];
timer_ = nil;
}
[substring_ setString:@""];
[self setSession:nil];
}
- (void)onOpen
{
}
- (void)reloadData:(BOOL)canChangeSide
{
[model_ removeAllObjects];
[unfilteredModel_ sortByScore];
for (PopupEntry* s in unfilteredModel_) {
if ([self _word:[s mainValue] matchesFilter:substring_]) {
[model_ addObject:s];
}
}
BOOL oldReloading = reloading_;
reloading_ = YES;
[tableView_ reloadData];
[self setPosition:canChangeSide];
[tableView_ sizeToFit];
[[tableView_ enclosingScrollView] setHasHorizontalScroller:NO];
if (!haveChangedSelection_ && [tableView_ numberOfRows] > 0) {
NSIndexSet* indexes = [NSIndexSet indexSetWithIndex:[self convertIndex:0]];
[tableView_ selectRowIndexes:indexes byExtendingSelection:NO];
} else if (haveChangedSelection_ && [tableView_ numberOfRows] > 0) {
int i = [model_ indexOfObjectWithMainValue:selectionMainValue_];
if (i >= 0) {
NSIndexSet* indexes = [NSIndexSet indexSetWithIndex:[self convertIndex:i]];
[tableView_ selectRowIndexes:indexes byExtendingSelection:NO];
}
}
reloading_ = oldReloading;
}
- (int)convertIndex:(int)i
{
return onTop_ ? [model_ count] - i - 1 : i;
}
- (void)_setClearFilterOnNextKeyDownFlag:(id)sender
{
clearFilterOnNextKeyDown_ = YES;
timer_ = nil;
}
- (void)setPosition:(BOOL)canChangeSide
{
BOOL onTop = NO;
VT100Screen* screen = [session_ SCREEN];
int cx = [screen cursorX] - 1;
int cy = [screen cursorY];
PTYTextView* tv = [session_ TEXTVIEW];
[tv scrollEnd];
NSRect frame = [[self window] frame];
frame.size.height = [[tableView_ headerView] frame].size.height + [model_ count] * ([tableView_ rowHeight] + [tableView_ intercellSpacing].height);
NSPoint p = NSMakePoint(MARGIN + cx * [tv charWidth],
([screen numberOfLines] - [screen height] + cy) * [tv lineHeight]);
p = [tv convertPoint:p toView:nil];
p = [[tv window] convertBaseToScreen:p];
p.y -= frame.size.height;
NSRect monitorFrame = [[[[[screen session] tab] parentWindow] windowScreen] visibleFrame];
if (canChangeSide) {
// p.y gives the bottom of the frame relative to the bottom of the screen, assuming it's below the cursor.
float bottomOverflow = monitorFrame.origin.y - p.y;
float topOverflow = p.y + 2 * frame.size.height + [tv lineHeight] - (monitorFrame.origin.y + monitorFrame.size.height);
if (bottomOverflow > 0 && topOverflow < bottomOverflow) {
onTop = YES;
}
} else {
onTop = onTop_;
}
if (onTop) {
p.y += frame.size.height + [tv lineHeight];
}
float rightX = monitorFrame.origin.x + monitorFrame.size.width;
if (p.x + frame.size.width > rightX) {
float excess = p.x + frame.size.width - rightX;
p.x -= excess;
}
frame.origin = p;
[[self window] setFrame:frame display:NO];
if (canChangeSide) {
BOOL flip = (onTop != onTop_);
[self setOnTop:onTop];
if (flip) {
BOOL oldReloading = reloading_;
reloading_ = YES;
NSIndexSet* indexes = [NSIndexSet indexSetWithIndex:[self convertIndex:[tableView_ selectedRow]]];
[tableView_ selectRowIndexes:indexes byExtendingSelection:NO];
reloading_ = oldReloading;
}
}
}
- (void)setOnTop:(BOOL)onTop
{
onTop_ = onTop;
}
- (void)keyDown:(NSEvent*)event
{
unichar c = [[event characters] characterAtIndex:0];
if (c == '\r') {
[self rowSelected:self];
} else if (c == 8 || c == 127) {
// backspace
if (timer_) {
[timer_ invalidate];
timer_ = nil;
}
clearFilterOnNextKeyDown_ = NO;
[substring_ setString:@""];
[self reloadData:NO];
} else if (!iswcntrl(c)) {
if (clearFilterOnNextKeyDown_) {
[substring_ setString:@""];
clearFilterOnNextKeyDown_ = NO;
}
[substring_ appendString:[event characters]];
[self reloadData:NO];
if (timer_) {
[timer_ invalidate];
}
timer_ = [NSTimer scheduledTimerWithTimeInterval:4
target:self
selector:@selector(_setClearFilterOnNextKeyDownFlag:)
userInfo:nil
repeats:NO];
} else if (c == 27) {
// Escape
[[self window] close];
[self onClose];
}
}
- (void)rowSelected:(id)sender
{
[[self window] close];
[self onClose];
}
- (NSAttributedString*)attributedStringForEntry:(PopupEntry*)entry isSelected:(BOOL)isSelected
{
float size = [NSFont systemFontSize];
NSFont* sysFont = [NSFont systemFontOfSize:size];
NSMutableAttributedString* as = [[[NSMutableAttributedString alloc] init] autorelease];
NSColor* textColor;
if (isSelected) {
textColor = [NSColor whiteColor];
} else {
textColor = [NSColor blackColor];
}
NSColor* lightColor = [textColor colorWithAlphaComponent:0.4];
NSDictionary* lightAttributes = [NSDictionary dictionaryWithObjectsAndKeys:
sysFont, NSFontAttributeName,
lightColor, NSForegroundColorAttributeName,
nil];
NSDictionary* plainAttributes = [NSDictionary dictionaryWithObjectsAndKeys:
sysFont, NSFontAttributeName,
textColor, NSForegroundColorAttributeName,
nil];
NSDictionary* boldAttributes = [NSDictionary dictionaryWithObjectsAndKeys:
[NSFont boldSystemFontOfSize:size], NSFontAttributeName,
textColor, NSForegroundColorAttributeName,
nil];
[as appendAttributedString:[[[NSAttributedString alloc] initWithString:[entry prefix] attributes:lightAttributes] autorelease]];
NSString* value = [[entry mainValue] stringByReplacingOccurrencesOfString:@"\n" withString:@" "];
NSString* temp = value;
for (int i = 0; i < [substring_ length]; ++i) {
unichar wantChar = [substring_ characterAtIndex:i];
NSRange r = [temp rangeOfString:[NSString stringWithCharacters:&wantChar length:1] options:NSCaseInsensitiveSearch];
if (r.location == NSNotFound) {
return nil;
}
NSRange prefix;
prefix.location = 0;
prefix.length = r.location;
NSAttributedString* attributedSubstr;
if (prefix.length > 0) {
NSString* substr = [temp substringWithRange:prefix];
attributedSubstr = [[[NSAttributedString alloc] initWithString:substr attributes:plainAttributes] autorelease];
[as appendAttributedString:attributedSubstr];
}
unichar matchChar = [temp characterAtIndex:r.location];
attributedSubstr = [[[NSAttributedString alloc] initWithString:[NSString stringWithCharacters:&matchChar length:1] attributes:boldAttributes] autorelease];
[as appendAttributedString:attributedSubstr];
r.length = [temp length] - r.location - 1;
++r.location;
temp = [temp substringWithRange:r];
}
if ([temp length] > 0) {
NSAttributedString* attributedSubstr = [[[NSAttributedString alloc] initWithString:temp
attributes:plainAttributes] autorelease];
[as appendAttributedString:attributedSubstr];
}
//[as appendAttributedString:[[[NSAttributedString alloc] initWithString:[NSString stringWithFormat:@" (%lf)", [entry score]] attributes:plainAttributes] autorelease]];
return as;
}
- (BOOL)_word:(NSString*)temp matchesFilter:(NSString*)filter
{
for (int i = 0; i < [filter length]; ++i) {
unichar wantChar = [filter characterAtIndex:i];
NSRange r = [temp rangeOfString:[NSString stringWithCharacters:&wantChar length:1] options:NSCaseInsensitiveSearch];
if (r.location == NSNotFound) {
return NO;
}
r.length = [temp length] - r.location - 1;
++r.location;
temp = [temp substringWithRange:r];
}
return YES;
}
// Delegate methods
- (void)windowDidResignKey:(NSNotification *)aNotification
{
[[self window] close];
[self onClose];
}
- (void)windowDidBecomeKey:(NSNotification *)aNotification
{
if (!session_) {
// A dialog box can cause you to become key after closing because of a
// race condition with twiddleKeyWindow. But it immediately loses key
// status again after this. Because it was already closed, there is no
// session at this point and we just return harmlessly.
return;
}
clearFilterOnNextKeyDown_ = NO;
if (timer_) {
[timer_ invalidate];
timer_ = nil;
}
[substring_ setString:@""];
[self onOpen];
haveChangedSelection_ = NO;
[selectionMainValue_ setString:@""];
[self refresh];
if ([tableView_ numberOfRows] > 0) {
BOOL oldReloading = reloading_;
reloading_ = YES;
NSIndexSet* indexes = [NSIndexSet indexSetWithIndex:[self convertIndex:0]];
[tableView_ selectRowIndexes:indexes byExtendingSelection:NO];
reloading_ = oldReloading;
}
}
- (void)refresh
{
}
// DataSource methods
- (NSInteger)numberOfRowsInTableView:(NSTableView *)aTableView
{
return [model_ count];
}
// Tableview delegate methods
- (id)tableView:(NSTableView *)aTableView objectValueForTableColumn:(NSTableColumn *)aTableColumn row:(NSInteger)rowIndex
{
int i = [self convertIndex:rowIndex];
PopupEntry* e = [[self model] objectAtIndex:i];
return [self attributedStringForEntry:e isSelected:[aTableView selectedRow]==rowIndex];
}
- (void)tableViewSelectionDidChange:(NSNotification *)aNotification
{
if (!reloading_) {
haveChangedSelection_ = YES;
int rowNum = [tableView_ selectedRow];
NSString* s = nil;
if (rowNum >= 0) {
s = [[model_ objectAtIndex:[self convertIndex:rowNum]] mainValue];
}
if (!s) {
s = @"";
}
[selectionMainValue_ setString:s];
}
}
@end
Jump to Line
Something went wrong with that request. Please try again.