awesome/objects/client.c at master · hishamhm/awesome

Repository navigation

History

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

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

* client.c - client management

* 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.,

* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

/** A process window.

* Clients are the name used by Awesome (and X11) to refer to a window. An

* application can have multiple clients (like for dialogs) or none at all

* (like command line applications). Clients are usually grouped by classes. A

* class is the name used by X11 to help window manager distinguish between

* window and write rules for them. See the `xprop` command line application. A

* client also have a `type` and `size_hints` used to define its behavior.

* ![Client geometry](../images/client_geo.svg)

* The client `:geometry()` return a table with *x*, *y*, *width* and *height*.

* The area returned **exclude the border width**. All clients also have a

* `shape_bounding` and `shape_clip` used to "crop" the client content. Finally,

* each clients can have titlebars (see `awful.titlebar`).

* Furthermore to the classes described here, one can also use signals as

* described in @{signals} and X properties as described in @{xproperties}.

* Some signal names are starting with a dot. These dots are artefacts from

* the documentation generation, you get the real signal name by

* removing the starting dot.

* Accessing client objects can be done in multiple ways depending on the

* context. To get the current focused client, use:

* local c = client.focus

* if c then

* -- do something

* end

* To get a list of all clients, use `client:get`

* for _, c in ipairs(client.get()) do

* -- do something

* end

* To get a callback when a new client is added, use the `manage` signal:

* client.connect_signal("manage", function(c)

* -- do something

* end)

* To be notified a property changed in a client, use:

* client.connect_signal("property::name", function(c)

* -- do something

* end)

* To be notified when a property change for a specific client (assuming it is

* stored in the variable `c`), use:

* c:connect_signal("property::name", function()

* -- do something

* end)

* To get all the clients for a screen, use either `screen.clients` or

* `screen.tiled_clients`

* @author Julien Danjou <julien@danjou.info>

* @release @AWESOME_VERSION@

* @classmod client

#include "objects/client.h"

#include "common/atoms.h"

#include "common/xutil.h"

#include "event.h"

#include "ewmh.h"

#include "objects/drawable.h"

#include "objects/screen.h"

#include "objects/tag.h"

#include "property.h"

#include "spawn.h"

#include "systray.h"

#include "xwindow.h"

#include "math.h"

#include <xcb/xcb_atom.h>

#include <xcb/shape.h>

#include <cairo-xcb.h>

/** Client class.

* @table object

/** When a client gains focus.

* @signal .focus

/** Before manage, after unmanage, and when clients swap.

* @signal .list

/** When 2 clients are swapped

* @tparam client client The other client

* @tparam boolean is_source If self is the source or the destination of the swap

* @signal .swapped

/**

* @signal .manage

/**

* @signal button::press

/**

* @signal button::release

/**

* @signal mouse::enter

/**

* @signal mouse::leave

/**

* @signal mouse::move

/**

* @signal property::window

/** When a client should get activated (focused and/or raised).

* Default implementation: `awful.ewmh.activate`.

* @signal request::activate

* @tparam string context The context where this signal was used.

* @tparam[opt] table hints A table with additional hints:

* @tparam[opt=false] boolean hints.raise should the client be raised?

/**

* @signal request::geometry

* @tparam client c The client

* @tparam string context Why and what to resize. This is used for the

* handlers to know if they are capable of applying the new geometry.

* @tparam[opt={}] table Additional arguments. Each context handler may

* interpret this differently.

/**

* @signal request::tag

/**

* @signal request::urgent

/** When a client gets tagged.

* @signal .tagged

* @tag t The tag object.

/** When a client gets unfocused.

* @signal .unfocus

/**

* @signal .unmanage

/** When a client gets untagged.

* @signal .untagged

* @tag t The tag object.

/**

* @signal .raised

/**

* @signal .lowered

/**

* The focused `client` or nil (in case there is none).

* @tfield client focus

/**

* The X window id.

* **Signal:**

* * *property::window*

* @property window

* @param string

/**

* The client title.

* **Signal:**

* * *property::name*

* @property name

* @param string

/**

* True if the client does not want to be in taskbar.

* **Signal:**

* * *property::skip\_taskbar*

* @property skip_taskbar

* @param boolean

/**

* The window type.

* Valid types are:

* * **desktop**: The root client, it cannot be moved or resized.

* * **dock**: A client attached to the side of the screen.

* * **splash**: A client, usually without titlebar shown when an application starts.

* * **dialog**: A dialog, see `transient_for`.

* * **menu**: A context menu.

* * **toolbar**: A floating toolbar.

* * **utility**:

* * **dropdown_menu**: A context menu attached to a parent position.

* * **popup_menu**: A context menu.

* * **notification**: A notification popup.

* * **combo**: A combobox list menu.

* * **dnd**: A drag and drop indicator.

* * **normal**: A normal application main window.

* More information can be found [here](https://specifications.freedesktop.org/wm-spec/wm-spec-latest.html#idm140200472629520)

* **Signal:**

* * *property::type*

* @property type

* @param string

/**

* The client class.

* If the client has multiple classes, the first one is used.

* To get a client class from the command line, use te `xprop` command.

* **Signal:**

* * *property::class*

* @property class

* @param string

/**

* The client instance.

* **Signal:**

* * *property::instance*

* @property instance

* @param string

/**

* The client PID, if available.

* **Signal:**

* * *property::pid*

* @property pid

* @param number

/**

* The window role, if available.

* **Signal:**

* * *property::role*

* @property role

* @param string

/**

* The machine client is running on.

* **Signal:**

* * *property::machine*

* @property machine

* @param string

/**

* The client name when iconified.

* **Signal:**

* * *property::icon\_name*

* @property icon_name

* @param string

/**

* The client icon.

* **Signal:**

* * *property::icon*

* @property icon

* @param surface

/**

* Client screen.

* **Signal:**

* * *property::screen*

* @property screen

* @param screen

/**

* Define if the client must be hidden, i.e. never mapped,

* invisible in taskbar.

* **Signal:**

* * *property::hidden*

* @property hidden

* @param boolean

/**

* Define it the client must be iconify, i.e. only visible in

* taskbar.

* **Signal:**

* * *property::minimized*

* @property minimized

* @param boolean

/**

* Honor size hints, e.g. respect size ratio.

* For example, a terminal such as `xterm` require the client size to be a

* multiple of the character size. Honoring size hints will cause the terminal

* window to have a small gap at the bottom.

* This is enabled by default. To disable it by default, see `awful.rules`.

* **Signal:**

* * *property::size\_hints\_honor*

* @property size_hints_honor

* @param boolean

* @see size_hints

/**

* The client border width.

* @property border_width

* @param integer

/**

* The client border color.

* **Signal:**

* * *property::border\_color*

* @see gears.color

* @property border_color

* @param pattern Any string, gradients and patterns will be converted to a

* cairo pattern.

/**

* The client urgent state.

* **Signal:**

* * *property::urgent*

* @property urgent

* @param boolean

/**

* A cairo surface for the client window content.

* To get the screenshot, use:

* gears.surface(c.content)

* To save it, use:

* gears.surface(c.content):write_to_png(path)

* @property content

* @param surface

/**

* The client opacity.

* **Signal:**

* * *property::opacity*

* @property opacity

* @param number Between 0 (transparent) to 1 (opaque)

/**

* The client is on top of every other windows.

* @property ontop

* @param boolean

/**

* The client is above normal windows.

* **Signal:**

* * *property::above*

* @property above

* @param boolean

/**

* The client is below normal windows.

* **Signal:**

* * *property::below*

* @property below

* @param boolean

/**

* The client is fullscreen or not.

* **Signal:**

* * *property::fullscreen*

* @property fullscreen

* @param boolean

/**

* The client is maximized (horizontally and vertically) or not.

* **Signal:**

* * *property::maximized*

* @property maximized

* @param boolean

/**

* The client is maximized horizontally or not.

* **Signal:**

* * *property::maximized\_horizontal*

* @property maximized_horizontal

* @param boolean

/**

* The client is maximized vertically or not.

* **Signal:**

* * *property::maximized\_vertical*

* @property maximized_vertical

* @param boolean

/**

* The client the window is transient for.

* **Signal:**

* * *property::transient\_for*

* @property transient_for

* @param client

/**

* Window identification unique to a group of windows.

* **Signal:**

* * *property::group\_window*

* @property group_window

* @param client

/**

* Identification unique to windows spawned by the same command.

* @property leader_window

* @param client

/**

* A table with size hints of the client.

* **Signal:**

* * *property::size\_hints*

* @property size_hints

* @param table

* @tfield integer table.user_position

* @tfield integer table.user_size

* @tfield integer table.program_position

* @tfield integer table.program_size

* @tfield integer table.max_width

* @tfield integer table.max_height

* @tfield integer table.min_width

* @tfield integer table.min_height

* @tfield integer table.width_inc

* @tfield integer table.height_inc

* @see size_hints_honor

/**

* Set the client sticky, i.e. available on all tags.

* **Signal:**

* * *property::sticky*

* @property sticky

* @param boolean

/**

* Indicate if the client is modal.

* **Signal:**

* * *property::modal*

* @property modal

* @param boolean

/**

* True if the client can receive the input focus.

* **Signal:**

* * *property::focusable*

* @property focusable

* @param boolean

/**

* The client's bounding shape as set by awesome as a (native) cairo surface.

* **Signal:**

* * *property::shape\_bounding*

* @see gears.surface.apply_shape_bounding

* @property shape_bounding

* @param surface

/**

* The client's clip shape as set by awesome as a (native) cairo surface.

* **Signal:**

* * *property::shape\_clip*

* @property shape_clip

* @param surface

/**

* The client's bounding shape as set by the program as a (native) cairo surface.

* **Signal:**

* * *property::shape\_client\_bounding*

* @property shape_client_bounding

* @param surface

/**

* The client's clip shape as set by the program as a (native) cairo surface.

* **Signal:**

* * *property::shape\_client\_clip*

* @property shape_client_clip

* @param surface

/**

* The FreeDesktop StartId.

* When a client is spawned (like using a terminal or `awful.spawn`, a startup

* notification identifier is created. When the client is created, this

* identifier remain the same. This allow to match a spawn event to an actual

* client.

* **Signal:**

* * *property::startup\_id*

* @property startup_id

* @param string

/**

* If the client that this object refers to is still managed by awesome.

* To avoid errors, use:

* local is_valid = pcall(function() return c.valid end) and c.valid

* **Signal:**

* * *property::valid*

* @property valid

* @param boolean

/**

* The first tag of the client. Optimized form of `c:tags()[1]`.

* **Signal:**

* * *property::first\_tag*

* @property first_tag

* @param tag

/**

* The border color when the client is focused.

* @beautiful beautiful.border_focus

* @param string

/**

* The border color when the client is not focused.

* @beautiful beautiful.border_normal

* @param string

/**

* The client border width.

* @beautiful beautiful.border_width

* @param integer

/** Return client struts (reserved space at the edge of the screen).

* @param struts A table with new strut values, or none.

* @return A table with strut values.

* @function struts

/** Get or set mouse buttons bindings for a client.

* @param buttons_table An array of mouse button bindings objects, or nothing.

* @return A table with all buttons.

* @function buttons

/** Get the number of instances.

* @return The number of client objects alive.

* @function instances

/* Set a __index metamethod for all client instances.

* @tparam function cb The meta-method

* @function set_index_miss_handler

/* Set a __newindex metamethod for all client instances.

* @tparam function cb The meta-method

* @function set_newindex_miss_handler

static area_t titlebar_get_area(client_t *c, client_titlebar_t bar);

static drawable_t *titlebar_get_drawable(lua_State *L, client_t *c, int cl_idx, client_titlebar_t bar);

static void client_resize_do(client_t *c, area_t geometry, bool force_notice);

/** Collect a client.

* \param L The Lua VM state.

* \return The number of element pushed on stack.

static void

client_wipe(client_t *c)

{

key_array_wipe(&c->keys);

xcb_icccm_get_wm_protocols_reply_wipe(&c->protocols);

p_delete(&c->machine);

p_delete(&c->class);

p_delete(&c->instance);

p_delete(&c->icon_name);

p_delete(&c->alt_icon_name);

p_delete(&c->name);

p_delete(&c->alt_name);

p_delete(&c->startup_id);

if(c->icon)

cairo_surface_destroy(c->icon);

}

/** Change the clients urgency flag.

* \param L The Lua VM state.

* \param cidx The client index on the stack.

* \param urgent The new flag state.

void

client_set_urgent(lua_State *L, int cidx, bool urgent)

{

client_t *c = luaA_checkudata(L, cidx, &client_class);

if(c->urgent != urgent)

{

c->urgent = urgent;

luaA_object_emit_signal(L, cidx, "property::urgent", 0);

}

#define DO_CLIENT_SET_PROPERTY(prop) \

void \

client_set_##prop(lua_State *L, int cidx, fieldtypeof(client_t, prop) value) \

{ \

client_t *c = luaA_checkudata(L, cidx, &client_class); \

if(c->prop != value) \

{ \

c->prop = value; \

luaA_object_emit_signal(L, cidx, "property::" #prop, 0); \

} \

}

DO_CLIENT_SET_PROPERTY(group_window)

DO_CLIENT_SET_PROPERTY(type)

DO_CLIENT_SET_PROPERTY(transient_for)

DO_CLIENT_SET_PROPERTY(pid)

DO_CLIENT_SET_PROPERTY(skip_taskbar)

#undef DO_CLIENT_SET_PROPERTY

#define DO_CLIENT_SET_STRING_PROPERTY2(prop, signal) \

void \

client_set_##prop(lua_State *L, int cidx, char *value) \

{ \

client_t *c = luaA_checkudata(L, cidx, &client_class); \

if (A_STREQ(c->prop, value)) \

{ \

p_delete(&value); \

return; \

} \

p_delete(&c->prop); \

c->prop = value; \

luaA_object_emit_signal(L, cidx, "property::" #signal, 0); \

}

#define DO_CLIENT_SET_STRING_PROPERTY(prop) \

DO_CLIENT_SET_STRING_PROPERTY2(prop, prop)

DO_CLIENT_SET_STRING_PROPERTY(name)

DO_CLIENT_SET_STRING_PROPERTY2(alt_name, name)

DO_CLIENT_SET_STRING_PROPERTY(icon_name)

DO_CLIENT_SET_STRING_PROPERTY2(alt_icon_name, icon_name)

DO_CLIENT_SET_STRING_PROPERTY(role)

DO_CLIENT_SET_STRING_PROPERTY(machine)

#undef DO_CLIENT_SET_STRING_PROPERTY

void

client_find_transient_for(client_t *c)

{

int counter;

client_t *tc, *tmp;

tmp = tc = client_getbywin(c->transient_for_window);

/* Verify that there are no loops in the transient_for relation after we are done */

for(counter = 0; tmp != NULL && counter <= globalconf.stack.len; counter++)

{

if (tmp == c)

/* We arrived back at the client we started from, so there is a loop */

counter = globalconf.stack.len+1;

tmp = tmp->transient_for;

}

if (counter <= globalconf.stack.len)

{

lua_State *L = globalconf_get_lua_State();

luaA_object_push(L, c);

client_set_transient_for(L, -1, tc);

lua_pop(L, 1);

}

void

client_set_class_instance(lua_State *L, int cidx, const char *class, const char *instance)

{

client_t *c = luaA_checkudata(L, cidx, &client_class);

p_delete(&c->class);

p_delete(&c->instance);

c->class = a_strdup(class);

luaA_object_emit_signal(L, cidx, "property::class", 0);

c->instance = a_strdup(instance);

luaA_object_emit_signal(L, cidx, "property::instance", 0);

}

/** Returns true if a client is tagged with one of the active tags.

* \param c The client to check.

* \return true if the client is visible, false otherwise.

bool

client_on_selected_tags(client_t *c)

{

if(c->sticky)

return true;

foreach(tag, globalconf.tags)

if(tag_get_selected(*tag) && is_client_tagged(c, *tag))

return true;

return false;

}

/** Get a client by its window.

* \param w The client window to find.

* \return A client pointer if found, NULL otherwise.

client_t *

client_getbywin(xcb_window_t w)

{

foreach(c, globalconf.clients)

if((*c)->window == w)

return *c;

return NULL;

}

client_t *

client_getbynofocuswin(xcb_window_t w)

{

foreach(c, globalconf.clients)

if((*c)->nofocus_window == w)

return *c;

return NULL;

}

/** Get a client by its frame window.

* \param w The client window to find.

* \return A client pointer if found, NULL otherwise.

client_t *

client_getbyframewin(xcb_window_t w)

{

foreach(c, globalconf.clients)

if((*c)->frame_window == w)

return *c;

return NULL;

}

/** Unfocus a client (internal).

* \param c The client.

static void

client_unfocus_internal(client_t *c)

{

lua_State *L = globalconf_get_lua_State();

globalconf.focus.client = NULL;

luaA_object_push(L, c);

luaA_object_emit_signal(L, -1, "unfocus", 0);

lua_pop(L, 1);

}

/** Unfocus a client.

* \param c The client.

static void

client_unfocus(client_t *c)

{

client_unfocus_internal(c);

globalconf.focus.need_update = true;

}

/** Check if client supports atom a protocol in WM_PROTOCOL.

* \param c The client.

* \param atom The protocol atom to check for.

* \return True if client has the atom in protocol, false otherwise.

bool

client_hasproto(client_t *c, xcb_atom_t atom)

{

for(uint32_t i = 0; i < c->protocols.atoms_len; i++)

if(c->protocols.atoms[i] == atom)

return true;

return false;

}

/** Prepare banning a client by running all needed lua events.

* \param c The client.

void client_ban_unfocus(client_t *c)

{

/* Wait until the last moment to take away the focus from the window. */

if(globalconf.focus.client == c)

client_unfocus(c);

}

/** Ban client and move it out of the viewport.

* \param c The client.

void

client_ban(client_t *c)

{

if(!c->isbanned)

{

xcb_unmap_window(globalconf.connection, c->frame_window);

c->isbanned = true;

client_ban_unfocus(c);

}

/** This is part of The Bob Marley Algorithm: we ignore enter and leave window

View remainder of file in raw view

FilesExpand file tree

client.c

Latest commit

History

client.c

File metadata and controls