~ubuntu-branches/ubuntu/oneiric/monodevelop/oneiric : revision 1.4.8

1

//

2

// TemplatePickerWidget.cs

3

//

4

// Author:

5

// Michael Hutchinson <mhutchinson@novell.com>

6

//

7

8

//

9

// Permission is hereby granted, free of charge, to any person obtaining a copy

10

// of this software and associated documentation files (the "Software"), to deal

11

// in the Software without restriction, including without limitation the rights

12

// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

13

// copies of the Software, and to permit persons to whom the Software is

14

// furnished to do so, subject to the following conditions:

15

//

16

// The above copyright notice and this permission notice shall be included in

17

// all copies or substantial portions of the Software.

18

//

19

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

20

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

21

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

22

// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

23

// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

24

// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

25

// THE SOFTWARE.

26

27

using System;

28

using System.Collections.Generic;

29

30

using Gtk;

31

using MonoDevelop.Core;

32

using MonoDevelop.Components;

33

using MonoDevelop.Ide.Templates;

34

using System.Linq;

35

using MonoDevelop.Ide.Gui.Components;

36

37

namespace MonoDevelop.Ide.Projects

38

{

39

class TemplatePickerWidget : Bin

40

{

41

SectionList sectionList = new SectionList ();

42

SectionList.Section recentSection, installedSection, onlineSection;

43

44

CategoryTreeView recentTemplateCatView = new CategoryTreeView ();

45

CategoryTreeView installedTemplateCatView = new CategoryTreeView ();

46

CategoryTreeView onlineTemplateCatView = new CategoryTreeView ();

47

48

List<TemplateItem> recentTemplates = new List<TemplateItem> ();

49

List<TemplateItem> installedTemplates = new List<TemplateItem> ();

50

List<TemplateItem> onlineTemplates = new List<TemplateItem> ();

51

52

HPaned hsplit = new HPaned ();

53

VPaned vsplit = new VPaned ();

54

VBox rightVbox = new VBox ();

55

HBox searchHbox = new HBox ();

56

57

CompactScrolledWindow infoScrolledWindow = new CompactScrolledWindow ();

58

VBox infoBox = new VBox ();

59

Label infoHeaderLabel = new Label ();

60

Label infoDecriptionLabel = new Label ();

61

62

SearchEntry searchEntry = new SearchEntry ();

63

64

TemplateView templateView = new TemplateView ();

65

66

public TemplatePickerWidget ()

67

{

68

Stetic.BinContainer.Attach (this);

69

70

infoBox.BorderWidth = 4;

71

infoBox.Spacing = 4;

72

infoHeaderLabel.Wrap = true;

73

infoHeaderLabel.Xalign = 0;

74

infoDecriptionLabel.Wrap = true;

75

infoDecriptionLabel.Xalign = 0;

76

infoDecriptionLabel.Yalign = 0;

77

78

infoBox.SizeAllocated += delegate {

79

var w = infoBox.Allocation.Width - 10;

80

if (infoHeaderLabel.WidthRequest != w) {

81

infoHeaderLabel.WidthRequest = w;

82

infoDecriptionLabel.WidthRequest = w;

83

}

84

};

85

86

recentSection = sectionList.AddSection (GettextCatalog.GetString ("Recent Templates"), recentTemplateCatView);

87

installedSection = sectionList.AddSection (GettextCatalog.GetString ("Installed Templates"), installedTemplateCatView);

88

onlineSection = sectionList.AddSection (GettextCatalog.GetString ("Online Templates"), onlineTemplateCatView);

89

90

recentSection.Activated += delegate {

91

LoadTemplatesIntoView (recentTemplates);

92

templateView.SetCategoryFilter (recentTemplateCatView.GetSelection ());

93

};

94

95

installedSection.Activated += delegate {

96

LoadTemplatesIntoView (installedTemplates);

97

templateView.SetCategoryFilter (installedTemplateCatView.GetSelection ());

98

};

99

100

onlineSection.Activated += delegate {

101

LoadTemplatesIntoView (onlineTemplates);

102

templateView.SetCategoryFilter (onlineTemplateCatView.GetSelection ());

103

};

104

105

recentTemplateCatView.SelectionChanged += delegate {

106

if (recentSection.IsActive)

107

templateView.SetCategoryFilter (recentTemplateCatView.GetSelection ());

108

};

109

110

installedTemplateCatView.SelectionChanged += delegate {

111

if (installedSection.IsActive)

112

templateView.SetCategoryFilter (installedTemplateCatView.GetSelection ());

113

};

114

115

onlineTemplateCatView.SelectionChanged += delegate {

116

if (onlineSection.IsActive)

117

templateView.SetCategoryFilter (onlineTemplateCatView.GetSelection ());

118

};

119

120

searchEntry.WidthRequest = 150;

121

searchEntry.EmptyMessage = GettextCatalog.GetString ("Search...");

122

searchEntry.Changed += delegate {

123

templateView.SetSearchFilter (searchEntry.Entry.Text);

124

};

125

searchEntry.Activated += delegate {

126

templateView.Child.GrabFocus ();

127

};

128

searchEntry.Ready = true;

129

searchEntry.Show ();

130

131

installedTemplateCatView.SelectionChanged += delegate (object sender, EventArgs e) {

132

var selection = installedTemplateCatView.GetSelection ();

133

templateView.SetCategoryFilter (selection);

134

};

135

136

templateView.SelectionChanged += TemplateSelectionChanged;

137

templateView.DoubleClicked += delegate {

138

OnActivated ();

139

};

140

141

Add (hsplit);

142

hsplit.Pack1 (sectionList, true, false);

143

hsplit.Pack2 (rightVbox, true, false);

144

rightVbox.PackStart (searchHbox, false, false, 0);

145

rightVbox.Spacing = 6;

146

searchHbox.PackStart (new Label (), true, true, 0);

147

searchHbox.PackStart (searchEntry, false, false, 0);

148

rightVbox.PackStart (vsplit, true, true, 0);

149

vsplit.Pack1 (templateView, true, false);

150

vsplit.Pack2 (infoScrolledWindow, true, false);

151

infoScrolledWindow.ShowBorderLine = true;

152

var vp = new Viewport ();

153

vp.ShadowType = ShadowType.None;

154

vp.Add (infoBox);

155

infoScrolledWindow.Add (vp);

156

infoBox.PackStart (infoHeaderLabel, false, false, 0);

157

infoBox.PackStart (infoDecriptionLabel, true, true, 0);

158

hsplit.ShowAll ();

159

160

//sane proportions for the splitter children

161

templateView.HeightRequest = 200;

162

infoScrolledWindow.HeightRequest = 75;

163

sectionList.WidthRequest = 150;

164

rightVbox.WidthRequest = 300;

165

166

sectionList.ActiveIndex = 1;

167

}

168

169

void TemplateSelectionChanged (object sender, EventArgs e)

170

{

171

var ti = templateView.CurrentlySelected;

172

if (ti == null) {

173

infoHeaderLabel.Markup = "";

174

infoDecriptionLabel.Text = "";

175

} else {

176

infoHeaderLabel.Markup = "" + GLib.Markup.EscapeText (ti.Name) + "";

177

infoDecriptionLabel.Text = StringParserService.Parse (ti.Template.Description);

178

}

179

OnSelectionChanged ();

180

}

181

182

void OnSelectionChanged ()

183

{

184

var evt = SelectionChanged;

185

if (evt != null)

186

evt (this, null);

187

}

188

189

void OnActivated ()

190

{

191

var evt = Activated;

192

if (evt != null)

193

evt (this, null);

194

}

195

196

public ProjectTemplate Selection {

197

get {

198

var sel = templateView.CurrentlySelected;

199

if (sel == null)

200

return null;

201

return sel.Template;

202

}

203

}

204

205

public void SelectTemplate (string id)

206

{

207

templateView.SelectTemplate (id);

208

}

209

210

public event EventHandler SelectionChanged;

211

public event EventHandler Activated;

212

213

void LoadTemplatesIntoView (List<TemplateItem> templates)

214

{

215

templateView.Clear ();

216

foreach (var t in templates) {

217

templateView.AddItem (t);

218

}

219

}

220

221

public void LoadInstalledTemplates (IEnumerable<ProjectTemplate> templates)

222

{

223

foreach (var template in templates) {

224

if (template == null)

225

throw new ArgumentException ("Null template");

226

installedTemplates.Add (new TemplateItem (template));

227

}

228

installedTemplates.Sort ((a,b) => String.Compare (a.Name, b.Name));

229

installedTemplateCatView.Load (installedTemplates);

230

231

232

if (installedTemplateCatView.GetSelection () == null)

233

installedTemplateCatView.SetSelection (new string[0]);

234

235

if (installedSection.IsActive)

236

LoadTemplatesIntoView (installedTemplates);

237

}

238

239

public void LoadRecentTemplates (IEnumerable<ProjectTemplate> templates)

240

{

241

foreach (var template in templates) {

242

if (template == null)

243

throw new ArgumentException ("Null template");

244

recentTemplates.Add (new TemplateItem (template));

245

}

246

//don't sort recent templates, they should already be in most->least recent

247

recentTemplateCatView.Load (recentTemplates);

248

249

if (recentTemplateCatView.GetSelection () == null)

250

recentTemplateCatView.SetSelection (new string[0]);

251

252

if (recentSection.IsActive)

253

LoadTemplatesIntoView (installedTemplates);

254

}

255

256

public string InstalledTemplateSelectedCategory {

257

get {

258

return string.Join ("/", installedTemplateCatView.GetSelection ());

259

}

260

set {

261

var cat = value.Split (new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries);

262

installedTemplateCatView.SetSelection (cat);

263

}

264

}

265

266

public string RecentTemplateSelectedCategory {

267

get {

268

return string.Join ("/", recentTemplateCatView.GetSelection ());

269

}

270

set {

271

var cat = value.Split (new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries);

272

recentTemplateCatView.SetSelection (cat);

273

}

274

}

275

276

class CategoryTreeView : CompactScrolledWindow

277

{

278

TreeView view = new TreeView ();

279

TreeStore store = new TreeStore (typeof (string));

280

281

public CategoryTreeView ()

282

{

283

view.Model = store;

284

view.HeadersVisible = false;

285

var col = new TreeViewColumn ();

286

var crt = new CellRendererText ();

287

col.PackStart (crt, false);

288

col.AddAttribute (crt, "markup", 0);

289

view.AppendColumn (col);

290

view.Selection.Changed += delegate {

291

if (SelectionChanged != null)

292

SelectionChanged (this, EventArgs.Empty);

293

};

294

this.Add (view);

295

}

296

297

public void Load (List<TemplateItem> templates)

298

{

299

store.Clear ();

300

301

string general = GettextCatalog.GetString ("General");

302

string all = GettextCatalog.GetString ("All");

303

var categories = new Dictionary<string, object> ();

304

305

foreach (var tp in templates) {

306

string[] catPath;

307

if (tp.Category == null || tp.Category.Length == 0)

308

catPath = new string[] { general };

309

else

310

catPath = tp.Category;

311

312

Dictionary<string, object> searchCats = categories;

313

for (int i = 0; i < catPath.Length; i++) {

314

string s = catPath[i];

315

KeyValuePair<string,object>? found = null;

316

foreach (var searchCat in searchCats)

317

if (searchCat.Key == s)

318

found = searchCat;

319

if (i < catPath.Length - 1) {

320

if (found.HasValue && found.Value.Value != null) {

321

searchCats = (Dictionary<string,object>) found.Value.Value;

322

} else {

323

var d = new Dictionary<string, object> ();

324

searchCats [s] = d;

325

searchCats = d;

326

}

327

} else if (!found.HasValue) {

328

searchCats.Add (s, null);

329

}

330

}

331

}

332

333

var iter = store.AppendValues (all);

334

BuildTree (iter, categories);

335

view.ExpandAll ();

336

}

337

338

void BuildTree (TreeIter parent, Dictionary<string, object> cats)

339

{

340

foreach (var cat in cats.OrderBy (kv => kv.Key)) {

341

var iter = store.AppendValues (parent, cat.Key);

342

if (cat.Value != null)

343

BuildTree (iter, (Dictionary<string, object>) cat.Value);

344

}

345

}

346

347

public IList<string> GetSelection ()

348

{

349

TreeIter selectedIter;

350

if (!view.Selection.GetSelected (out selectedIter))

351

return null;

352

353

string[] selection = new string[store.IterDepth (selectedIter)];

354

TreeIter iter;

355

356

//root is the "all" category

357

store.GetIterFirst (out iter);

358

if (iter.Equals (selectedIter))

359

return selection;

360

store.IterChildren (out iter, iter);

361

362

for (int i = 0; i < selection.Length; i++) {

363

do {

364

if (iter.Equals (selectedIter)) {

365

selection[i] = (string) store.GetValue (iter, 0);

366

return selection;

367

} else if (store.IsAncestor (iter, selectedIter)) {

368

selection[i] = (string) store.GetValue (iter, 0);

369

store.IterChildren (out iter, iter);

370

break;

371

}

372

} while (store.IterNext (ref iter));

373

}

374

return selection;

375

}

376

377

public void SetSelection (IList<string> value)

378

{

379

TreeIter parent;

380

if (!store.GetIterFirst (out parent))

381

return;

382

383

//root is the "all" node, matched by zero-length selection array

384

if (value.Count == 0) {

385

view.Selection.SelectIter (parent);

386

return;

387

}

388

389

TreeIter iter;

390

store.IterChildren (out iter, parent);

391

392

int i = 0;

393

while (store.IterNext (ref iter)) {

394

var s = (string) store.GetValue (iter, 0);

395

if (s == value[i]) {

396

i++;

397

TreeIter child;

398

if (i == value.Count || !store.IterChildren (out child, iter)) {

399

view.Selection.SelectIter (iter);

400

return;

401

}

402

parent = iter;

403

iter = child;

404

}

405

}

406

view.Selection.SelectIter (parent);

407

}

408

409

public event EventHandler SelectionChanged;

410

}

411

412

class TemplateView: CompactScrolledWindow

413

{

414

TemplateTreeView tree;

415

IList<string> categoryFilter;

416

string searchFilter;

417

418

public TemplateView ()

419

{

420

ShowBorderLine = true;

421

tree = new TemplateTreeView ();

422

tree.Selection.Changed += delegate {

423

if (SelectionChanged != null)

424

SelectionChanged (this, EventArgs.Empty);

425

};

426

tree.RowActivated += delegate {

427

if (DoubleClicked != null)

428

DoubleClicked (this, EventArgs.Empty);

429

};

430

431

Add (tree);

432

HscrollbarPolicy = PolicyType.Automatic;

433

VscrollbarPolicy = PolicyType.Automatic;

434

ShadowType = ShadowType.None;

435

ShowAll ();

436

}

437

438

public TemplateItem CurrentlySelected {

439

get { return tree.CurrentlySelected; }

440

}

441

442

public void SelectTemplate (string id)

443

{

444

tree.SelectItem (id);

445

}

446

447

public void AddItem (TemplateItem templateItem)

448

{

449

tree.AddItem (templateItem);

450

}

451

452

public void Clear ()

453

{

454

tree.Clear ();

455

}

456

457

public void SetCategoryFilter (IList<string> categoryFilter)

458

{

459

this.categoryFilter = categoryFilter;

460

Refilter ();

461

}

462

463

public void SetSearchFilter (string search)

464

{

465

this.searchFilter = search;

466

Refilter ();

467

}

468

469

bool MatchesCategory (TemplateItem item)

470

{

471

if (categoryFilter == null)

472

return true;

473

if (item.Category == null || item.Category.Length < categoryFilter.Count)

474

return false;

475

for (int i = 0; i < categoryFilter.Count; i++)

476

if (item.Category[i] != categoryFilter[i])

477

return false;

478

return true;

479

}

480

481

bool MatchesSearch (TemplateItem item)

482

{

483

return string.IsNullOrWhiteSpace (searchFilter)

484

|| item.Name.IndexOf (searchFilter, StringComparison.CurrentCultureIgnoreCase) >= 0

485

|| item.Template.Description.IndexOf (searchFilter, StringComparison.CurrentCultureIgnoreCase) >= 0;

486

}

487

488

void Refilter ()

489

{

490

tree.Filter (item => MatchesSearch (item) && MatchesCategory (item));

491

}

492

493

public event EventHandler SelectionChanged;

494

public event EventHandler DoubleClicked;

495

}

496

497

class TemplateTreeView: TreeView

498

{

499

Gtk.ListStore templateStore;

500

TreeModelFilter filterModel;

501

Func<TemplateItem,bool> filterFunc;

502

503

public TemplateTreeView ()

504

{

505

HeadersVisible = false;

506

templateStore = new ListStore (typeof(TemplateItem));

507

Model = filterModel = new TreeModelFilter (templateStore, null);

508

filterModel.VisibleFunc = FilterFuncWrapper;

509

510

var col = new TreeViewColumn ();

511

var crp = new CellRendererIcon () {

512

StockSize = (uint) Gtk.IconSize.Dnd,

513

Ypad = 2,

514

};

515

col.PackStart (crp, false);

516

col.SetCellDataFunc (crp, CellDataFuncIcon);

517

518

var crt = new CellRendererText ();

519

col.PackStart (crt, false);

520

col.SetCellDataFunc (crt, CellDataFuncText);

521

522

AppendColumn (col);

523

ShowAll ();

524

}

525

526

bool FilterFuncWrapper (TreeModel model, TreeIter iter)

527

{

528

if (filterFunc == null)

529

return true;

530

var item = (TemplateItem) model.GetValue (iter, 0);

531

532

//gets called while the rows are being inserted and don't yet have data

533

if (item == null)

534

return false;

535

536

return filterFunc (item);

537

}

538

539

void CellDataFuncText (TreeViewColumn col, CellRenderer cell, TreeModel model, TreeIter iter)

540

{

541

var item = (TemplateItem) model.GetValue (iter, 0);

542

string name = GLib.Markup.EscapeText (item.Name);

543

if (!string.IsNullOrEmpty (item.Template.LanguageName))

544

name += "\n" + item.Template.LanguageName + "";

545

546

((CellRendererText)cell).Markup = name;

547

}

548

549

void CellDataFuncIcon (TreeViewColumn col, CellRenderer cell, TreeModel model, TreeIter iter)

550

{

551

var item = (TemplateItem) model.GetValue (iter, 0);

552

var id = item.Template.Icon.IsNull ? "md-project" : item.Template.Icon.ToString ();

553

((CellRendererIcon)cell).StockId = id;

554

}

555

556

public void Filter (Func<TemplateItem,bool> filter)

557

{

558

this.filterFunc = filter;

559

this.filterModel.Refilter ();

560

}

561

562

public TemplateItem CurrentlySelected {

563

get {

564

Gtk.TreeIter iter;

565

if (!Selection.GetSelected (out iter))

566

return null;

567

return (TemplateItem) filterModel.GetValue (iter, 0);

568

}

569

}

570

571

public void SelectItem (string id)

572

{

573

Gtk.TreeIter iter;

574

if (filterModel.GetIterFirst (out iter)) {

575

do {

576

var t = (TemplateItem) filterModel.GetValue (iter, 0);

577

if (t.Template.Id == id) {

578

Selection.SelectIter (iter);

579

return;

580

}

581

} while (filterModel.IterNext (ref iter));

582

}

583

}

584

585

public void AddItem (TemplateItem templateItem)

586

{

587

templateStore.AppendValues (templateItem);

588

}

589

590

public void Clear ()

591

{

592

templateStore.Clear ();

593

}

594

595

protected override void OnDestroyed ()

596

{

597

filterModel.Dispose ();

598

templateStore.Dispose ();

599

}

600

}

601

602

class TemplateItem

603

{

604

public TemplateItem (ProjectTemplate template)

605

{

606

Name = StringParserService.Parse (template.Name);

607

this.Template = template;

608

if (!string.IsNullOrEmpty (template.Category))

609

this.Category = template.Category.Split (new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries);

610

else

611

this.Category = new string[0];

612

}

613

614

public string Name { get; private set; }

615

public string[] Category { get; private set; }

616

public ProjectTemplate Template { get; private set; }

617

}

618

}

619

}

620